org.jibx.schema.types
Class Count

java.lang.Object
  extended by org.jibx.schema.types.Count

public class Count
extends java.lang.Object

Repetition count in a schema definition.

Author:
Dennis M. Sosnoski

Field Summary
static Count COUNT_ONE
          Predefined count of '1'.
static Count COUNT_UNBOUNDED
          Predefined count of 'unbounded'.
static Count COUNT_ZERO
          Predefined count of '0'.
private  int m_count
          Actual count for bounded value.
private  boolean m_unbounded
          Flag for unbounded value.
 
Constructor Summary
private Count(int count, boolean unbounded)
          Internal constructor.
 
Method Summary
static Count getBoundedCount(java.lang.String value)
          Deserializer method for bounded values.
 int getCount()
          Get count value.
static Count getCount(java.lang.String value)
          Deserializer method.
static boolean isCountEqual(int value, Count count)
          Check if a count attribute is equal to a specified value.
 boolean isEqual(int value)
          Check for count equal to a particular value.
 boolean isGreaterThan(int value)
          Check for count greater than a particular value.
 boolean isUnbounded()
          Check for unbounded count.
 java.lang.String toString()
          Conversion to text form.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COUNT_ZERO

public static final Count COUNT_ZERO
Predefined count of '0'.


COUNT_ONE

public static final Count COUNT_ONE
Predefined count of '1'.


COUNT_UNBOUNDED

public static final Count COUNT_UNBOUNDED
Predefined count of 'unbounded'.


m_count

private final int m_count
Actual count for bounded value.


m_unbounded

private final boolean m_unbounded
Flag for unbounded value.

Constructor Detail

Count

private Count(int count,
              boolean unbounded)
Internal constructor.

Parameters:
count -
unbounded -
Method Detail

getCount

public int getCount()
Get count value. This method throws an exception if used with an unbounded value, so always try isUnbounded() first.

Returns:
count

isUnbounded

public boolean isUnbounded()
Check for unbounded count.

Returns:
unbounded flag

isEqual

public boolean isEqual(int value)
Check for count equal to a particular value. This is a convenience method which avoids the need to separately check unbounded and then compare the count.

Parameters:
value -
Returns:
equal flag

isGreaterThan

public boolean isGreaterThan(int value)
Check for count greater than a particular value. This is a convenience method which avoids the need to separately check unbounded and then compare the count.

Parameters:
value -
Returns:
greater than flag

getBoundedCount

public static Count getBoundedCount(java.lang.String value)
                             throws JiBXException
Deserializer method for bounded values.

Parameters:
value - text representation
Returns:
instance of class
Throws:
JiBXException - on conversion error

getCount

public static Count getCount(java.lang.String value)
                      throws JiBXException
Deserializer method.

Parameters:
value - text representation
Returns:
instance of class (null if none)
Throws:
JiBXException - on conversion error

isCountEqual

public static boolean isCountEqual(int value,
                                   Count count)
Check if a count attribute is equal to a specified value. If the count is null, the value is taken as '1'.

Parameters:
value -
count -
Returns:
true if value equal, false if not

toString

public java.lang.String toString()
Conversion to text form.

Overrides:
toString in class java.lang.Object
Returns:
count as text


Project Web Site