JabRef 5.15 · org.jabref.logic.cleanup.Formatter · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	Formatter()

Access

Constructor and Description

public

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the object is a formatter with the same key equals(Object the object to compare the formatter to obj) Overrides java.lang.Object.equals. Indicates whether some other object is the same formatter as this one based on the key.
public abstract String	Returns: the formatted output String format(String the input String value) Formats a field value by with a particular formatter transformation.
public abstract String	Returns: the description string, always non empty getDescription() Returns a description of the formatter.
public abstract String	Returns: the example input string, always non empty getExampleInput() Returns an example input string of the formatter.
public abstract String	Returns: the key of the formatter, always not null getKey() Returns a unique key for the formatter that can be used for its identification
public abstract String	Returns: the name of the formatter, always not null getName() Returns a human readable name of the formatter usable for e.g. in the GUI
public int	Returns: the hash of the key of the formatter hashCode() Overrides java.lang.Object.hashCode. Returns a default hashcode of the formatter based on its key.

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

Formatter	back to summary
public Formatter()

Formatter

back to summary

public Formatter()

Method Detail

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is the same formatter as this one based on the key. Parameters obj:Object the object to compare the formatter to Returns:boolean true if the object is a formatter with the same key Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is the same formatter as this one based on the key.

Parameters

obj:Object: the object to compare the formatter to

Returns:boolean

true if the object is a formatter with the same key

Annotations

@Override

format	back to summary
public abstract String format(String value) Formats a field value by with a particular formatter transformation. Calling this method with a null argument results in a NullPointerException. Parameters value:String the input String Returns:String the formatted output String

format

back to summary

public abstract String format(String value)

Formats a field value by with a particular formatter transformation.

Calling this method with a null argument results in a NullPointerException.

Parameters

value:String: the input String

Returns:String

the formatted output String

getDescription	back to summary
public abstract String getDescription() Returns a description of the formatter. Returns:String the description string, always non empty

getDescription

back to summary

public abstract String getDescription()

Returns a description of the formatter.

Returns:String: the description string, always non empty

getExampleInput	back to summary
public abstract String getExampleInput() Returns an example input string of the formatter. This example is used as input to the formatter to demonstrate its functionality Returns:String the example input string, always non empty

getExampleInput

back to summary

public abstract String getExampleInput()

Returns an example input string of the formatter. This example is used as input to the formatter to demonstrate its functionality

Returns:String: the example input string, always non empty

getKey	back to summary
public abstract String getKey() Returns a unique key for the formatter that can be used for its identification Returns:String the key of the formatter, always not null

getKey

back to summary

public abstract String getKey()

Returns a unique key for the formatter that can be used for its identification

Returns:String: the key of the formatter, always not null

getName	back to summary
public abstract String getName() Returns a human readable name of the formatter usable for e.g. in the GUI Returns:String the name of the formatter, always not null

getName

back to summary

public abstract String getName()

Returns a human readable name of the formatter usable for e.g. in the GUI

Returns:String: the name of the formatter, always not null

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a default hashcode of the formatter based on its key. Returns:int the hash of the key of the formatter Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a default hashcode of the formatter based on its key.

Returns:int

the hash of the key of the formatter

Annotations

@Override

public abstract Class Formatter

Constructor Summary

Method Summary

Constructor Detail

Method Detail