|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math3.geometry.VectorFormat<S>
S
- Type of the space.public abstract class VectorFormat<S extends Space>
Formats a vector in components list format "{x; y; ...}".
The prefix and suffix "{" and "}" and the separator "; " can be replaced by any user-defined strings. The number format for components can be configured.
White space is ignored at parse time, even if it is in the prefix, suffix or separator specifications. So even if the default separator does include a space character that is used at format time, both input string "{1;1;1}" and " { 1 ; 1 ; 1 } " will be parsed without error and the same vector will be returned. In the second case, however, the parse position after parsing will be just after the closing curly brace, i.e. just before the trailing space.
Field Summary | |
---|---|
static String |
DEFAULT_PREFIX
The default prefix: "{". |
static String |
DEFAULT_SEPARATOR
The default separator: ", ". |
static String |
DEFAULT_SUFFIX
The default suffix: "}". |
Constructor Summary | |
---|---|
protected |
VectorFormat()
Create an instance with default settings. |
protected |
VectorFormat(NumberFormat format)
Create an instance with a custom number format for components. |
protected |
VectorFormat(String prefix,
String suffix,
String separator)
Create an instance with custom prefix, suffix and separator. |
protected |
VectorFormat(String prefix,
String suffix,
String separator,
NumberFormat format)
Create an instance with custom prefix, suffix, separator and format for components. |
Method Summary | |
---|---|
protected StringBuffer |
format(StringBuffer toAppendTo,
FieldPosition pos,
double... coordinates)
Formats the coordinates of a Vector to produce a string. |
String |
format(Vector<S> vector)
Formats a Vector object to produce a string. |
abstract StringBuffer |
format(Vector<S> vector,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a Vector object to produce a string. |
static Locale[] |
getAvailableLocales()
Get the set of locales for which point/vector formats are available. |
NumberFormat |
getFormat()
Get the components format. |
String |
getPrefix()
Get the format prefix. |
String |
getSeparator()
Get the format separator between components. |
String |
getSuffix()
Get the format suffix. |
abstract Vector<S> |
parse(String source)
Parses a string to produce a Vector object. |
abstract Vector<S> |
parse(String source,
ParsePosition pos)
Parses a string to produce a Vector object. |
protected double[] |
parseCoordinates(int dimension,
String source,
ParsePosition pos)
Parses a string to produce an array of coordinates. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_PREFIX
public static final String DEFAULT_SUFFIX
public static final String DEFAULT_SEPARATOR
Constructor Detail |
---|
protected VectorFormat()
The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
protected VectorFormat(NumberFormat format)
format
- the custom format for components.protected VectorFormat(String prefix, String suffix, String separator)
prefix
- prefix to use instead of the default "{"suffix
- suffix to use instead of the default "}"separator
- separator to use instead of the default "; "protected VectorFormat(String prefix, String suffix, String separator, NumberFormat format)
prefix
- prefix to use instead of the default "{"suffix
- suffix to use instead of the default "}"separator
- separator to use instead of the default "; "format
- the custom format for components.Method Detail |
---|
public static Locale[] getAvailableLocales()
This is the same set as the NumberFormat
set.
public String getPrefix()
public String getSuffix()
public String getSeparator()
public NumberFormat getFormat()
public String format(Vector<S> vector)
Vector
object to produce a string.
vector
- the object to format.
public abstract StringBuffer format(Vector<S> vector, StringBuffer toAppendTo, FieldPosition pos)
Vector
object to produce a string.
vector
- the object to format.toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the
offsets of the alignment field
protected StringBuffer format(StringBuffer toAppendTo, FieldPosition pos, double... coordinates)
Vector
to produce a string.
toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the
offsets of the alignment fieldcoordinates
- coordinates of the object to format.
public abstract Vector<S> parse(String source) throws MathParseException
Vector
object.
source
- the string to parse
Vector
object.
MathParseException
- if the beginning of the specified string
cannot be parsed.public abstract Vector<S> parse(String source, ParsePosition pos)
Vector
object.
source
- the string to parsepos
- input/output parsing parameter.
Vector
object.protected double[] parseCoordinates(int dimension, String source, ParsePosition pos)
dimension
- dimension of the spacesource
- the string to parsepos
- input/output parsing parameter.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |