Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	BibtexString.Type Type of a \@String.

Modifier and Type	Field and Description
private String	content
private boolean	hasChanged
private String	id
private String	name
private String	parsedSerialization
private BibtexString.Type	type

Constructor Summary

Access	Constructor and Description
public	BibtexString(String name, String content) Default constructor.
public	BibtexString(String name, String content, String The serialization read during parsing parsedSerialization) This is used to set the parsed serialization of the string.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getContent()
public String	getId()
public String	getName() Returns the name/label of the string
public String	getParsedSerialization()
public BibtexString.Type	getType()
public String	getUserComments()
public boolean	hasChanged()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setContent(String content)
public void	setId(String id)
public void	setName(String name)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

content	back to summary
private String content

hasChanged	back to summary
private boolean hasChanged

id	back to summary
private String id

name	back to summary
private String name

parsedSerialization	back to summary
private String parsedSerialization

type	back to summary
private BibtexString.Type type

Constructor Detail

BibtexString	back to summary
public BibtexString(String name, String content) Default constructor. Use this if in doubt. In case this constructor is used - and the library is eventually written, the serialization is generated from scratch (and not some null from parsedSerialization)

BibtexString	back to summary
public BibtexString(String name, String content, String parsedSerialization) This is used to set the parsed serialization of the string. This is used when the string is read from a BibTeX file. Do not use if not working with reading BibTeX files (or similar actions). * Parameters parsedSerialization:String The serialization read during parsing

BibtexString

back to summary

public BibtexString(String name, String content, String parsedSerialization)

This is used to set the parsed serialization of the string. This is used when the string is read from a BibTeX file. Do not use if not working with reading BibTeX files (or similar actions). *

Parameters

parsedSerialization:String: The serialization read during parsing

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getContent	back to summary
public String getContent()

getId	back to summary
public String getId()

getName	back to summary
public String getName() Returns the name/label of the string

getParsedSerialization	back to summary
public String getParsedSerialization()

getType	back to summary
public BibtexString.Type getType()

getUserComments	back to summary
public String getUserComments()

hasChanged	back to summary
public boolean hasChanged()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

setContent	back to summary
public void setContent(String content)

setId	back to summary
public void setId(String id)

setName	back to summary
public void setName(String name)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.jabref.model.entry back to summary

public final Enum BibtexString.Type

Class Inheritance

extends Enum<BibtexString.Type>

java.lang.Object
java.lang.Enum
org.jabref.model.entry.BibtexString.Type

Type of a \@String.

Differentiate a \@String based on its usage:

- AUTHOR: prefix "a", for author and editor fields. - INSTITUTION: prefix "i", for institution and organization field - PUBLISHER: prefix "p", for publisher fields - OTHER: no prefix, for any field

Examples:

\@String { aKahle = "Kahle, Brewster " } -> author \@String { aStallman = "Stallman, Richard" } -> author \@String { iMIT = "{Massachusetts Institute of Technology ({MIT})}" } -> institution \@String { pMIT = "{Massachusetts Institute of Technology ({MIT}) press}" } -> publisher \@String { anct = "Anecdote" } -> other \@String { eg = "for example" } -> other \@String { et = " and " } -> other \@String { lBigMac = "Big Mac" } -> other

Usage:

\@Misc { title = "The GNU Project" author = aStallman # et # aKahle institution = iMIT publisher = pMIT note = "Just " # eg }

Field Summary

Modifier and Type	Field and Description
public static final BibtexString.Type	AUTHOR
public static final BibtexString.Type	INSTITUTION
public static final BibtexString.Type	OTHER
private final String	prefix
public static final BibtexString.Type	PUBLISHER

Constructor Summary

Access	Constructor and Description
private	Type(String prefix)

Method Summary

Modifier and Type	Method and Description
public static BibtexString.Type	get(String key)
public static BibtexString.Type	valueOf(String name)
public static BibtexString.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AUTHOR	back to summary
public static final BibtexString.Type AUTHOR

INSTITUTION	back to summary
public static final BibtexString.Type INSTITUTION

OTHER	back to summary
public static final BibtexString.Type OTHER

prefix	back to summary
private final String prefix

PUBLISHER	back to summary
public static final BibtexString.Type PUBLISHER

Constructor Detail

Type	back to summary
private Type(String prefix)

Method Detail

get	back to summary
public static BibtexString.Type get(String key)

valueOf	back to summary
public static BibtexString.Type valueOf(String name)

values	back to summary
public static BibtexString.Type[] values()

public Class BibtexString

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum BibtexString.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail