|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.text.Format
org.apache.commons.math.util.CompositeFormat
org.apache.commons.math.linear.RealVectorFormat
public class RealVectorFormat
Formats a vector in components list format "{v0; v1; ...; vk-1}".
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.text.Format |
---|
java.text.Format.Field |
Field Summary | |
---|---|
private static java.lang.String |
DEFAULT_PREFIX
The default prefix: "{". |
private static java.lang.String |
DEFAULT_SEPARATOR
The default separator: ", ". |
private 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 static long |
serialVersionUID
Serializable version identifier |
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 | |
---|---|
RealVectorFormat()
Create an instance with default settings. |
|
RealVectorFormat(java.text.NumberFormat format)
Create an instance with a custom number format for components. |
|
RealVectorFormat(java.lang.String prefix,
java.lang.String suffix,
java.lang.String separator)
Create an instance with custom prefix, suffix and separator. |
|
RealVectorFormat(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 | |
---|---|
java.lang.StringBuffer |
format(java.lang.Object obj,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Formats a object to produce a string. |
java.lang.StringBuffer |
format(RealVector vector,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Formats a RealVector object to produce a string. |
static java.lang.String |
formatRealVector(RealVector v)
This static method calls Format.format(Object) on a default instance of
RealVectorFormat. |
static java.util.Locale[] |
getAvailableLocales()
Get the set of locales for which real vectors formats are available. |
java.text.NumberFormat |
getFormat()
Get the components format. |
static RealVectorFormat |
getInstance()
Returns the default real vector format for the current locale. |
static RealVectorFormat |
getInstance(java.util.Locale locale)
Returns the default real vector format for the given locale. |
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. |
ArrayRealVector |
parse(java.lang.String source)
Parses a string to produce a RealVector object. |
ArrayRealVector |
parse(java.lang.String source,
java.text.ParsePosition pos)
Parses a string to produce a RealVector object. |
java.lang.Object |
parseObject(java.lang.String source,
java.text.ParsePosition pos)
Parses a string to produce a object. |
Methods inherited from class org.apache.commons.math.util.CompositeFormat |
---|
formatDouble, getDefaultNumberFormat, getDefaultNumberFormat, parseAndIgnoreWhitespace, parseFixedstring, parseNextCharacter, parseNumber |
Methods inherited from class java.text.Format |
---|
clone, format, formatToCharacterIterator, parseObject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final long serialVersionUID
private static final java.lang.String DEFAULT_PREFIX
private static final java.lang.String DEFAULT_SUFFIX
private static final java.lang.String DEFAULT_SEPARATOR
private final java.lang.String prefix
private final java.lang.String suffix
private final java.lang.String separator
private final java.lang.String trimmedPrefix
private final java.lang.String trimmedSuffix
private final java.lang.String trimmedSeparator
private final java.text.NumberFormat format
Constructor Detail |
---|
public RealVectorFormat()
The instance uses the default prefix, suffix and separator: "{", "}", and "; " and the default number format for components.
public RealVectorFormat(java.text.NumberFormat format)
format
- the custom format for components.public RealVectorFormat(java.lang.String prefix, java.lang.String suffix, java.lang.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 "; "public RealVectorFormat(java.lang.String prefix, java.lang.String suffix, java.lang.String separator, java.text.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 java.util.Locale[] getAvailableLocales()
This is the same set as the NumberFormat
set.
public java.lang.String getPrefix()
public java.lang.String getSuffix()
public java.lang.String getSeparator()
public java.text.NumberFormat getFormat()
public static RealVectorFormat getInstance()
public static RealVectorFormat getInstance(java.util.Locale locale)
locale
- the specific locale used by the format.
public static java.lang.String formatRealVector(RealVector v)
Format.format(Object)
on a default instance of
RealVectorFormat.
v
- RealVector object to format
public java.lang.StringBuffer format(RealVector vector, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
RealVector
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
public java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
obj
must be a RealVector
object. Any other type of
object will result in an IllegalArgumentException
being thrown.
format
in class java.text.Format
obj
- 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
java.lang.IllegalArgumentException
- is obj
is not a valid type.Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
public ArrayRealVector parse(java.lang.String source) throws java.text.ParseException
RealVector
object.
source
- the string to parse
RealVector
object.
java.text.ParseException
- if the beginning of the specified string
cannot be parsed.public ArrayRealVector parse(java.lang.String source, java.text.ParsePosition pos)
RealVector
object.
source
- the string to parsepos
- input/ouput parsing parameter.
RealVector
object.public java.lang.Object parseObject(java.lang.String source, java.text.ParsePosition pos)
parseObject
in class java.text.Format
source
- the string to parsepos
- input/ouput parsing parameter.
Format.parseObject(java.lang.String, java.text.ParsePosition)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |