org.arch4j.domain
Class StringDomain

java.lang.Object
  |
  +--org.arch4j.domain.Domain
        |
        +--org.arch4j.domain.StringDomain

All Implemented Interfaces:

Serializable

public abstract class StringDomain

extends Domain

Represents a string value. Implementing classes will override the getMaxLength and potentially the getMinLength methods. Bounds checking is automatically enforced.

Version:

1.0

Author:

David Colwell

See Also:

Serialized Form

Constructor Summary

StringDomain()
Default constructor.

StringDomain(Object aValue)
Constructor which sets the domain's value to the specified argument.

Method Summary

protected abstract int	getMaxLength() Defines the maximum string length used in validation.
protected int	getMinLength() Defines the minimun string length used in validation.
protected String	getValueClass() The base class Domain will verify that any specified values are of this type or a subclass of this type.
protected void	validate(Object aValue) Validates that aValue fits within the bounds defined by getMinLength and getMaxLength.

Methods inherited from class org.arch4j.domain.Domain

getValue, setValue, toString, validateType

Methods inherited from class java.lang.Object

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

Constructor Detail

StringDomain

public StringDomain()

Default constructor. Ultimately, the base class, Domain, will set the domain's value to null.

StringDomain

public StringDomain(Object aValue)
             throws DomainValidationException

Constructor which sets the domain's value to the specified argument.

Method Detail

getMinLength

protected int getMinLength()

Defines the minimun string length used in validation. Unless overridden, it will return 0.

Returns:

the minimum string length.

getMaxLength

protected abstract int getMaxLength()

Defines the maximum string length used in validation.

Returns:

the maximum string length.

validate

protected void validate(Object aValue)
                 throws DomainValidationException

Validates that aValue fits within the bounds defined by getMinLength and getMaxLength.

Specified by:

validate in class Domain

Throws:

DomainValidationException - if the bounds check validation fail.

getValueClass

protected String getValueClass()

The base class Domain will verify that any specified values are of this type or a subclass of this type.

Specified by:

getValueClass in class Domain

Returns:

the String representation of the Class type used by this domain value container.