Class Vector2DFormat
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}" and " { 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.
Note: using "," as a separator may interfere with the grouping separator
of the default NumberFormat
for the current locale. Thus it is advised
to use a NumberFormat
instance with disabled grouping in such a case.
-
Field Summary
Fields inherited from class org.hipparchus.geometry.VectorFormat
DEFAULT_PREFIX, DEFAULT_SEPARATOR, DEFAULT_SUFFIX
-
Constructor Summary
ConstructorDescriptionCreate an instance with default settings.Vector2DFormat
(String prefix, String suffix, String separator) Create an instance with custom prefix, suffix and separator.Vector2DFormat
(String prefix, String suffix, String separator, NumberFormat format) Create an instance with custom prefix, suffix, separator and format for components.Vector2DFormat
(NumberFormat format) Create an instance with a custom number format for components. -
Method Summary
Modifier and TypeMethodDescriptionformat
(Vector<Euclidean2D, Vector2D> vector, StringBuffer toAppendTo, FieldPosition pos) Formats aVector
object to produce a string.static Vector2DFormat
Returns the default 2D vector format for the current locale.static Vector2DFormat
getVector2DFormat
(Locale locale) Returns the default 2D vector format for the given locale.Parses a string to produce aVector
object.parse
(String source, ParsePosition pos) Parses a string to produce aVector
object.Methods inherited from class org.hipparchus.geometry.VectorFormat
format, format, getAvailableLocales, getFormat, getPrefix, getSeparator, getSuffix, parseCoordinates
-
Constructor Details
-
Vector2DFormat
public Vector2DFormat()Create an instance with default settings.The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
-
Vector2DFormat
Create an instance with a custom number format for components.- Parameters:
format
- the custom format for components.
-
Vector2DFormat
Create an instance with custom prefix, suffix and separator.- Parameters:
prefix
- prefix to use instead of the default "{"suffix
- suffix to use instead of the default "}"separator
- separator to use instead of the default "; "
-
Vector2DFormat
Create an instance with custom prefix, suffix, separator and format for components.- Parameters:
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 Details
-
getVector2DFormat
Returns the default 2D vector format for the current locale.- Returns:
- the default 2D vector format.
- Since:
- 1.4
-
getVector2DFormat
Returns the default 2D vector format for the given locale.- Parameters:
locale
- the specific locale used by the format.- Returns:
- the 2D vector format specific to the given locale.
- Since:
- 1.4
-
format
public StringBuffer format(Vector<Euclidean2D, Vector2D> vector, StringBuffer toAppendTo, FieldPosition pos) Formats aVector
object to produce a string.- Specified by:
format
in classVectorFormat<Euclidean2D,
Vector2D> - Parameters:
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- Returns:
- the value passed in as toAppendTo.
-
parse
Parses a string to produce aVector
object.- Specified by:
parse
in classVectorFormat<Euclidean2D,
Vector2D> - Parameters:
source
- the string to parse- Returns:
- the parsed
Vector
object. - Throws:
MathIllegalStateException
- if the beginning of the specified string cannot be parsed.
-
parse
Parses a string to produce aVector
object.- Specified by:
parse
in classVectorFormat<Euclidean2D,
Vector2D> - Parameters:
source
- the string to parsepos
- input/output parsing parameter.- Returns:
- the parsed
Vector
object.
-