org.yarnandtail.andhow.valuetype

Class StrType

java.lang.Object

org.yarnandtail.andhow.valuetype.BaseValueType<String>

org.yarnandtail.andhow.valuetype.StrType

All Implemented Interfaces:

ValueType<String>

public class StrType
extends BaseValueType<String>

Metadata and parsing for configuration Properties of the String type.

This class is threadsafe and uses a singleton pattern to prevent multiple instances, since all users can safely share the same instance.

Field Summary

Fields inherited from class org.yarnandtail.andhow.valuetype.BaseValueType

clazzType

Method Summary

Modifier and Type	Method and Description
String	cast(Object o) Attempt to cast the passed object to the generic type T.
static StrType	instance()
String	parse(String sourceValue) To parse the String type, the passed String is simply returned.

Methods inherited from class org.yarnandtail.andhow.valuetype.BaseValueType

getDestinationType, isParsable, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instance

public static StrType instance()

Returns:

An instance of the StrType()

parse

public String parse(String sourceValue)
             throws ParsingException

To parse the String type, the passed String is simply returned.

Parameters:

sourceValue - The source string, which should already be trimmed and may be null

Returns:

The parsed value, which is simply the passed value.

Throws:

ParsingException - (never thrown)

cast

public String cast(Object o)
            throws RuntimeException

Description copied from interface: ValueType

Attempt to cast the passed object to the generic type T. AndHow uses this internally to cast values known to already be of type T, but were stored in a generic way. If used for unknown types that are not castable to T, it will throw a RuntimeException, though this should never happen unless used by application code.

Returns:

Throws:

RuntimeException