java.lang.Object
- com.iizix.value.StringValue

All Implemented Interfaces:
IValueObject<java.lang.String>
```
public class StringValue
extends java.lang.Object
implements IValueObject<java.lang.String>
```
Value object class to handle the String datatype.
Author:
Christopher Mindus

Constructor Summary
Constructors
Constructor Description
StringValue()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`asLong(java.lang.String value, LocaleInfo localeInfo)`	Returns a long value if possible.
`java.lang.String`	`convert(java.lang.Object value, Value.Type oldType, LocaleInfo localeInfo)`	Converts a value from another type.
`java.lang.String`	`createDefault()`	Creates the default value object for the data type.
`java.lang.String`	`getDescription()`	Gets the description of the type, used for the Designer.
`java.text.Format`	`getFormatter(java.lang.String pattern, LocaleInfo localeInfo)`	Returns the Formatter for a pattern.
`java.lang.Class<java.lang.String>`	`getValueClass()`	Gets the class of the value.
`Value.Type`	`getValueType()`	Gets the value type.
`java.lang.String`	`load(java.lang.String value, org.w3c.dom.Element element)`	Loads the value from an Element.
`java.lang.String`	`parse(java.lang.String value)`	Creates a Value object from a String using a specified pattern and locale.
`java.lang.String`	`parse(java.lang.String value, java.lang.String pattern, LocaleInfo localeInfo)`	Creates a Value object from a String using a specified pattern and locale.
`java.lang.String`	`save(java.lang.String value, org.w3c.dom.Element element)`	Saves the value to an Element.
`java.lang.String`	`toString(java.lang.String value)`	The default "toString" representation.
`java.lang.String`	`toString(java.lang.String value, java.lang.String pattern, LocaleInfo localeInfo)`	Formats the value to a String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.iizix.value.IValueObject
asLongCast, isRightAligned, saveCast, toStringCast, toStringForced

- Constructor Detail
  - StringValue
```
public StringValue()
```
- Method Detail
  - getValueType
```
public final Value.Type getValueType()
```
    Gets the value type.
    Specified by:
    getValueType in interface IValueObject<java.lang.String>
    Returns:
    Value.Type.String.
  - getValueClass
```
public java.lang.Class<java.lang.String> getValueClass()
```
    Gets the class of the value.
    Specified by:
    getValueClass in interface IValueObject<java.lang.String>
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of the type, used for the Designer.
    Specified by:
    getDescription in interface IValueObject<java.lang.String>
  - createDefault
```
public java.lang.String createDefault()
```
    Creates the default value object for the data type.
    Specified by:
    createDefault in interface IValueObject<java.lang.String>
    Returns:
    The default value.
  - parse
```
public java.lang.String parse(java.lang.String value)
                       throws java.text.ParseException,
                              java.lang.Exception
```
    Creates a Value object from a String using a specified pattern and locale.
    Specified by:
    parse in interface IValueObject<java.lang.String>
    Parameters:
    value - The value, never null.
    Returns:
    The value object, never null.
    Throws:
    java.text.ParseException - If the value could not be parsed.
    java.lang.Exception - For other errors.
  - parse
```
public java.lang.String parse(java.lang.String value,
                              java.lang.String pattern,
                              LocaleInfo localeInfo)
                       throws java.text.ParseException,
                              java.lang.Exception
```
    Creates a Value object from a String using a specified pattern and locale.
    Specified by:
    parse in interface IValueObject<java.lang.String>
    Parameters:
    value - The value, never null.
    pattern - The pattern, null for none.
    localeInfo - The locale info, null for default.
    Returns:
    The value object, never null.
    Throws:
    java.text.ParseException - If the value could not be parsed.
    java.lang.Exception - For other errors.
  - getFormatter
```
public java.text.Format getFormatter(java.lang.String pattern,
                                     LocaleInfo localeInfo)
```
    Returns the Formatter for a pattern.
    Specified by:
    getFormatter in interface IValueObject<java.lang.String>
    Parameters:
    pattern - The pattern to use, null for none.
    localeInfo - The locale information instance, or null for none.
    Returns:
    The formatter to use, or null for none.
  - toString
```
public java.lang.String toString(java.lang.String value)
```
    The default "toString" representation.
    Specified by:
    toString in interface IValueObject<java.lang.String>
    Parameters:
    value - The value could be null.
    Returns:
    The String representation.
  - toString
```
public java.lang.String toString(java.lang.String value,
                                 java.lang.String pattern,
                                 LocaleInfo localeInfo)
```
    Formats the value to a String.
    Specified by:
    toString in interface IValueObject<java.lang.String>
    Parameters:
    value - The value is never null.
    pattern - Pattern to use, null for none.
    localeInfo - The locale information instance, or null for none.
    Returns:
    The String representation using specified pattern and locale information.
  - load
```
public java.lang.String load(java.lang.String value,
                             org.w3c.dom.Element element)
                      throws java.lang.Exception
```
    Loads the value from an Element.
    Specified by:
    load in interface IValueObject<java.lang.String>
    Parameters:
    value - The String value in the element.
    element - The element holding the information for advanced processing using JAXB.
    Throws:
    java.lang.Exception - An exception due to parsing, bean unmarshalling, etc.
  - save
```
public java.lang.String save(java.lang.String value,
                             org.w3c.dom.Element element)
                      throws java.lang.Exception
```
    Saves the value to an Element.
    Specified by:
    save in interface IValueObject<java.lang.String>
    Parameters:
    value - The value to save.
    element - The element to save information into for advanced processing using JAXB.
    Returns:
    The String value to set in the Element, or null if advanced processing is used.
    Throws:
    java.lang.Exception
  - convert
```
public java.lang.String convert(java.lang.Object value,
                                Value.Type oldType,
                                LocaleInfo localeInfo)
```
    Converts a value from another type. If the type is not defined, check the object instance for possible conversions.
    Specified by:
    convert in interface IValueObject<java.lang.String>
    Parameters:
    value - The value to convert.
    oldType - The old type, null for not defined.
    localeInfo - The locale information, null to look-up from current thread or if not found, for system default.
    Returns:
    The value object.
  - asLong
```
public long asLong(java.lang.String value,
                   LocaleInfo localeInfo)
```
    Returns a long value if possible.
    Specified by:
    asLong in interface IValueObject<java.lang.String>
    Parameters:
    value - The Value object.
    localeInfo - The locale information, null to look-up from current thread or if not found, for system default.
    Returns:
    The long value, e.g. in milliseconds, or Long.MIN_VALUE for not possible.

Class StringValue

Field Summary

Fields inherited from interface com.iizix.value.IValueObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.value.IValueObject

Constructor Detail

StringValue

Method Detail

getValueType

getValueClass

getDescription

createDefault

parse

parse

getFormatter

toString

toString

load

save

convert

asLong