com.tailf.jnc

Class YangBaseString

java.lang.Object

com.tailf.jnc.YangBaseString

All Implemented Interfaces:

YangType<java.lang.String>, java.io.Serializable

Direct Known Subclasses:

YangEnumeration, YangString

public class YangBaseString
extends java.lang.Object

A String wrapper extended by built in String based types.

White space collapse and replace methods, regexp pattern matchers, and length assertion methods are provided.

Author:

emil@tail-f.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	value The value of this object, of which this class is a wrapper for.

Constructor Summary

Constructors

Constructor and Description
YangBaseString(java.lang.String value) Creates a YangBaseString object from a java.lang.String.

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(java.lang.Object obj) Compares type of obj with this object to see if they can be equal.
void	check() Checks that the value of this object is not null.
com.tailf.jnc.YangBaseType<T>	clone() Clones this object and its value.
protected YangBaseString	cloneShallow() Clones this object without cloning its value.
boolean	equals(java.lang.Object obj) Compares this object with another object for equality.
protected void	exact(int length) Checks that the value of this object has the specified length.
protected java.lang.String	fromString(java.lang.String s) Identity method provided because this class extends the YangBaseType class.
T	getValue()
int	hashCode()
protected void	max(int length) Checks that the value of this object has at most the specified length.
protected void	min(int length) Checks that the value of this object has at least the specified length.
protected void	pattern(java.lang.String regex) Checks that a regular expression matches the value of this object.
protected void	pattern(java.lang.String[] regexes) Checks that a set of regular expressions match the value of this object.
void	setValue(java.lang.String value) Sets the value of this object using a java.lang.String.
java.lang.String	toString()
protected void	wsCollapse() Whitespace replace.
protected void	wsReplace() Whitespace replace.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected T value

The value of this object, of which this class is a wrapper for.

Constructor Detail

YangBaseString

public YangBaseString(java.lang.String value)
               throws YangException

Creates a YangBaseString object from a java.lang.String.

Parameters:

value - The Java String.

Throws:

YangException - If an invariant was broken during assignment.

Method Detail

setValue

public void setValue(java.lang.String value)
              throws YangException

Sets the value of this object using a java.lang.String.

Specified by:

setValue in interface YangType<java.lang.String>

Parameters:

value - The Java String.

Throws:

YangException - If an invariant was broken during assignment.

fromString

protected java.lang.String fromString(java.lang.String s)

Identity method provided because this class extends the YangBaseType class.

Parameters:

s - A string.

Returns:

s.

canEqual

public boolean canEqual(java.lang.Object obj)

Compares type of obj with this object to see if they can be equal.

Parameters:

obj - Object to compare type with.

Returns:

true if obj is an instance of YangBaseString or java.lang.String; false otherwise.

cloneShallow

protected YangBaseString cloneShallow()
                               throws YangException

Clones this object without cloning its value.

Returns:

A shallow clone of this object.

Throws:

YangException

pattern

protected void pattern(java.lang.String regex)
                throws YangException

Checks that a regular expression matches the value of this object.

Parameters:

regex - The regular expression.

Throws:

YangException - If regexp has a syntax error or does not match.

pattern

protected void pattern(java.lang.String[] regexes)
                throws YangException

Checks that a set of regular expressions match the value of this object.

Parameters:

regexes - The regular expressions.

Throws:

YangException - If any regexp in regexes has a syntax error or does not match.

wsReplace

protected void wsReplace()

Whitespace replace. Replaces all occurrences of #x9 (tab), #xA (line feed), and #xD (CR) with #x20 (space).

wsCollapse

protected void wsCollapse()

Whitespace replace. Contiguous sequences of 0x20 are collapsed into a single 0x20, and initial and/or final 0x20s are deleted.

exact

protected void exact(int length)
              throws YangException

Checks that the value of this object has the specified length.

Parameters:

length - The required length of this value

Throws:

YangException - If the comparison does not evaluate to true.

min

protected void min(int length)
            throws YangException

Checks that the value of this object has at least the specified length.

Parameters:

length - The lower limit of the length of this value

Throws:

YangException - if value is shorter than length.

max

protected void max(int length)
            throws YangException

Checks that the value of this object has at most the specified length.

Parameters:

length - The upper limit of the length of this value.

Throws:

YangException - if value is longer than length.

getValue

public T getValue()

Specified by:

getValue in interface YangType<T>

Returns:

The value of this object.

check

public void check()
           throws YangException

Description copied from interface: YangType

Checks that the value of this object is not null. Called in constructors and value setters. Subclasses that have state invariants should extend this method and throw a YangException if such an invariant has been violated.

Specified by:

check in interface YangType<T>

Throws:

YangException - If the value of this object is null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The value of this object, as a String.

equals

public boolean equals(java.lang.Object obj)

Compares this object with another object for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare with.

Returns:

true if obj can be cast to a comparable type and the value of this object is equal to the value of obj; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public com.tailf.jnc.YangBaseType<T> clone()

Description copied from interface: YangType

Clones this object and its value.

Specified by:

clone in interface YangType<T>

Overrides:

clone in class java.lang.Object

Returns:

A deep clone of this object.