Example:
"John von Neumann" => "von Neumann, John"
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: true if the object is a formatter with the same keythe object to compare the formatter to obj)Overrides java. Indicates whether some other object is the same formatter as this one based on the key. |
| public abstract String | |
| public abstract String | Returns: the description string, always non emptyReturns a description of the formatter. |
| public abstract String | Returns: the example input string, always non emptyReturns an example input string of the formatter. |
| public abstract String | Returns: the key of the formatter, always not nullReturns a unique key for the formatter that can be used for its identification |
| public abstract String | Returns: the name of the formatter, always not nullReturns a human readable name of the formatter usable for e.g. in the GUI |
| public int | Returns: the hash of the key of the formatterOverrides java. Returns a default hashcode of the formatter based on its key. |
| Formatter | back to summary |
|---|---|
| public Formatter() | |
| equals | back to summary |
|---|---|
| public boolean equals(Object obj) Overrides java. Indicates whether some other object is the same formatter as this one based on the key. | |
| 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. | |
| getDescription | back to summary |
|---|---|
| public abstract String getDescription() Returns a description of the formatter.
| |
| 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
| |
| getKey | back to summary |
|---|---|
| public abstract String getKey() Returns a unique key for the formatter that can be used for its identification
| |
| getName | back to summary |
|---|---|
| public abstract String getName() Returns a human readable name of the formatter usable for e.g. in the GUI
| |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Returns a default hashcode of the formatter based on its key.
| |