us.gov.dod.standard.ssrf._3_1.adapter

Class AXmlAdapterInteger

java.lang.Object

javax.xml.bind.annotation.adapters.XmlAdapter<String,Integer>

us.gov.dod.standard.ssrf._3_1.adapter.AXmlAdapterInteger

Direct Known Subclasses:

XmlAdapterIFNUM, XmlAdapterUS_PERCENT

public class AXmlAdapterInteger
extends XmlAdapter<String,Integer>

Abstract Number type XmlAdapter.

The maximum and minimum digit lengths plus inclusive values are identified in the constructor.

• UN(x) is an unsigned (positive) integer number of maximum x digits
• SN(x) is an integer number of maximum x digits (excluding minus sign)
• UN(x.y) is a unsigned (positive) decimal number of maximum x digits (excluding decimal point as applicable) and with a maximum of y decimal digits.
• SN(x.y) is a decimal number of maximum x digits (excluding minus sign and decimal point as applicable) and with a maximum of y decimal digits.
• double is a number expressing either in floating point (e.g. 0.015) or scientific notation or using scientific notation (decimal number followed by an optional "E" for the power of 10, e.g. 1.5E-2 representing the same value 0.015).

Where applicable, the types UN and SN may be followed by an additional range constraint in the form [a .. b] meaning that the value is restricted to be between a and b inclusive. They may also be followed by an additional unit in parenthesis. Example: Sensitivity value: SN(5.2) [-140.00 .. -30.00] (dBm)

Author:

Jesse Caulfield

Constructor Summary

Constructors

Constructor and Description
AXmlAdapterInteger(Integer totalDigits) Construct a new Number adapter.
AXmlAdapterInteger(Integer totalDigits, Integer minInclusive, Integer maxInclusive) Construct a new Number adapter.

Method Summary

Modifier and Type	Method and Description
Number	getMaxValue() Get the maximum value allowed by this adapter.
Number	getMinValue() Get the minimum value allowed by this adapter.
String	marshal(Integer v) Convert a bound type to a value type.
Integer	unmarshal(String v) Convert a value type to a bound type.

Methods inherited from class java.lang.Object

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

Constructor Detail

AXmlAdapterInteger

public AXmlAdapterInteger(Integer totalDigits)

Construct a new Number adapter. The minimum and maximum inclusive values are not set, supporting unsigned, unbound numbers within the digit count.

Parameters:

totalDigits - The maximum number of total digits in the number, inclusive of fraction digits. e.g. 123.456 contains 6 digits.

fractionDigits - The maximum number of fraction digits - number of digits to the right of the decimal. e.g. 123.456 contains 3 fraction digits.

AXmlAdapterInteger

public AXmlAdapterInteger(Integer totalDigits,
                          Integer minInclusive,
                          Integer maxInclusive)

Construct a new Number adapter.

Parameters:

totalDigits - The maximum number of total digits in the number, inclusive of fraction digits. e.g. 123.456 contains 6 digits.

fractionDigits - The maximum number of fraction digits - number of digits to the right of the decimal. e.g. 123.456 contains 3 fraction digits.

minInclusive - The minimum inclusive value.

maxInclusive - The maximum inclusive value.

Method Detail

marshal

public String marshal(Integer v)
               throws Exception

Convert a bound type to a value type.

This is called when converting an object to XML.

Specified by:

marshal in class XmlAdapter<String,Integer>

Parameters:

v - The value to be convereted. Can be null.

Returns:

the converted value

Throws:

Exception - if there's an error during the conversion. The caller is responsible for reporting the error to the user through ValidationEventHandler.

unmarshal

public Integer unmarshal(String v)
                  throws Exception

Convert a value type to a bound type.

This is called with converting XML to an object.

Specified by:

unmarshal in class XmlAdapter<String,Integer>

Parameters:

v - The value to be converted. Can be null.

Returns:

the converted value

Throws:

Exception - if there's an error during the conversion. The caller is responsible for reporting the error to the user through ValidationEventHandler.

getMaxValue

public Number getMaxValue()

Get the maximum value allowed by this adapter.

Returns:

the maximum allowed value. Integer.MAX_VALUE if not set.

getMinValue

public Number getMinValue()

Get the minimum value allowed by this adapter.

Returns:

the minimum allowed value. Integer.MIN_VALUE if not set.