org.apache.commons.math3.geometry

## Class VectorFormat<S extends Space>

- java.lang.Object
- - org.apache.commons.math3.geometry.VectorFormat<S>

Type Parameters:
  `S` - Type of the space.

Direct Known Subclasses:
  Vector1DFormat, Vector2DFormat, Vector3DFormat

    public abstract class VectorFormat<S extends Space>
    extends java.lang.Object

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.

Since:
  3.0
Version:
  $Id: VectorFormat.java 1416643 2012-12-03 19:37:14Z tn $

### Field Summary

Fields
`static java.lang.String` `DEFAULT_PREFIX` The default prefix: "{".
`static java.lang.String` `DEFAULT_SEPARATOR` The default separator: ", ".
`static java.lang.String` `DEFAULT_SUFFIX` The default suffix: "}".
`private java.text.NumberFormat` `format` The format used for components.
`private java.lang.String` `prefix` Prefix.
`private java.lang.String` `separator` Separator.
`private java.lang.String` `suffix` Suffix.
`private java.lang.String` `trimmedPrefix` Trimmed prefix.
`private java.lang.String` `trimmedSeparator` Trimmed separator.
`private java.lang.String` `trimmedSuffix` Trimmed suffix.

### Constructor Summary

Constructors
`protected` `VectorFormat()` Create an instance with default settings.
`protected` `VectorFormat(java.text.NumberFormat format)` Create an instance with a custom number format for components.
`protected` `VectorFormat(java.lang.String prefix, java.lang.String suffix, java.lang.String separator)` Create an instance with custom prefix, suffix and separator.
`protected` `VectorFormat(java.lang.String prefix, java.lang.String suffix, java.lang.String separator, java.text.NumberFormat format)` Create an instance with custom prefix, suffix, separator and format for components.

### Method Summary

Methods
`protected java.lang.StringBuffer` `format(java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos, double... coordinates)` Formats the coordinates of a `Vector` to produce a string.
`java.lang.String` `format(Vector<S> vector)` Formats a `Vector` object to produce a string.
`abstract java.lang.StringBuffer` `format(Vector<S> vector, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)` Formats a `Vector` object to produce a string.
`static java.util.Locale[]` `getAvailableLocales()` Get the set of locales for which point/vector formats are available.
`java.text.NumberFormat` `getFormat()` Get the components format.
`java.lang.String` `getPrefix()` Get the format prefix.
`java.lang.String` `getSeparator()` Get the format separator between components.
`java.lang.String` `getSuffix()` Get the format suffix.
`abstract Vector<S>` `parse(java.lang.String source)` Parses a string to produce a `Vector` object.
`abstract Vector<S>` `parse(java.lang.String source, java.text.ParsePosition pos)` Parses a string to produce a `Vector` object.
`protected double[]` `parseCoordinates(int dimension, java.lang.String source, java.text.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

#### DEFAULT_PREFIX

    public static final java.lang.String DEFAULT_PREFIX

The default prefix: "{".

See Also:
  Constant Field Values

#### DEFAULT_SUFFIX

    public static final java.lang.String DEFAULT_SUFFIX

The default suffix: "}".

See Also:
  Constant Field Values

#### DEFAULT_SEPARATOR

    public static final java.lang.String DEFAULT_SEPARATOR

The default separator: ", ".

See Also:
  Constant Field Values

#### prefix

    private final java.lang.String prefix

Prefix.

#### suffix

    private final java.lang.String suffix

Suffix.

#### separator

    private final java.lang.String separator

Separator.

#### trimmedPrefix

    private final java.lang.String trimmedPrefix

Trimmed prefix.

#### trimmedSuffix

    private final java.lang.String trimmedSuffix

Trimmed suffix.

#### trimmedSeparator

    private final java.lang.String trimmedSeparator

Trimmed separator.

#### format

    private final java.text.NumberFormat format

The format used for components.

### Constructor Detail

#### VectorFormat

    protected VectorFormat()

Create an instance with default settings.

The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.

#### VectorFormat

    protected VectorFormat(java.text.NumberFormat format)

Create an instance with a custom number format for components.

Parameters:
  `format` - the custom format for components.

#### VectorFormat

    protected VectorFormat(java.lang.String prefix,
                java.lang.String suffix,
                java.lang.String separator)

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 "; "

#### VectorFormat

    protected VectorFormat(java.lang.String prefix,
                java.lang.String suffix,
                java.lang.String separator,
                java.text.NumberFormat format)

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 Detail

#### getAvailableLocales

    public static java.util.Locale[] getAvailableLocales()

Get the set of locales for which point/vector formats are available.

This is the same set as the `NumberFormat` set.

Returns:
  available point/vector format locales.

#### getPrefix

    public java.lang.String getPrefix()

Get the format prefix.

Returns:
  format prefix.

#### getSuffix

    public java.lang.String getSuffix()

Get the format suffix.

Returns:
  format suffix.

#### getSeparator

    public java.lang.String getSeparator()

Get the format separator between components.

Returns:
  format separator.

#### getFormat

    public java.text.NumberFormat getFormat()

Get the components format.

Returns:
  components format.

#### format

    public java.lang.String format(Vector<S> vector)

Formats a `Vector` object to produce a string.

Parameters:
  `vector` - the object to format.
Returns:
  a formatted string.

#### format

    public abstract java.lang.StringBuffer format(Vector<S> vector,
                                java.lang.StringBuffer toAppendTo,
                                java.text.FieldPosition pos)

Formats a `Vector` object to produce a string.

Parameters:
  `vector` - the object to format.
  `toAppendTo` - where the text is to be appended
  `pos` - On input: an alignment field, if desired. On output: the offsets of the alignment field
Returns:
  the value passed in as toAppendTo.

#### format

    protected java.lang.StringBuffer format(java.lang.StringBuffer toAppendTo,
                                java.text.FieldPosition pos,
                                double... coordinates)

Formats the coordinates of a `Vector` to produce a string.

Parameters:
  `toAppendTo` - where the text is to be appended
  `pos` - On input: an alignment field, if desired. On output: the offsets of the alignment field
  `coordinates` - coordinates of the object to format.
Returns:
  the value passed in as toAppendTo.

#### parse

    public abstract Vector<S> parse(java.lang.String source)
                                           throws MathParseException

Parses a string to produce a `Vector` object.

Parameters:
  `source` - the string to parse
Returns:
  the parsed `Vector` object.
Throws:
  `MathParseException` - if the beginning of the specified string cannot be parsed.

#### parse

    public abstract Vector<S> parse(java.lang.String source,
                  java.text.ParsePosition pos)

Parses a string to produce a `Vector` object.

Parameters:
  `source` - the string to parse
  `pos` - input/output parsing parameter.
Returns:
  the parsed `Vector` object.

#### parseCoordinates

    protected double[] parseCoordinates(int dimension,
                            java.lang.String source,
                            java.text.ParsePosition pos)

Parses a string to produce an array of coordinates.

Parameters:
  `dimension` - dimension of the space
  `source` - the string to parse
  `pos` - input/output parsing parameter.
Returns:
  coordinates array.