Picture

java.lang.Object
- java.lang.Number
- - com.heirloomcomputing.epli.runtime.Picture

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.lang.Object>
```
public final class Picture
extends java.lang.Number
implements java.lang.Comparable<java.lang.Object>
```
Picture - immutable Java class implementation of the PL/I Picture data type. Pictures Java objects are translated from the PL/I PICTURE declared typically as DCL P PICTURE '99.99'; or DCL Q PICTURE 'X(3)';. Pictures have numeric qualities when used in arithmetic expressions and character qualities when used in input / output statements, so they share both attributes of a PL/I CODEDARITHMETIC and STRING variable type. When declared with character attributes (X, A) the Picture data type operates as STRING, when declared with numeric attributes (9, ., V, CR) it takes on the role of a CODEDARITHMETIC. This data type covers both for simplicity even though, for example, CONVERSION CONDITIONs will be unconditionally raised if an arithmetic operation involves a STRING Picture.
Picture also supports PL/I commoning attributes such as DATE which performs correct comparisons when two variables with like attributes are compared.
See IBM Enterprise PL/I Language Reference 5.1, PICTURE data element, pg. 66 and Picture specification characters, ch 14, pg 355 for more information. Picture specifications may include the following:

Character Specification Characters
stored as Unicode String Java type
A ASCII character constant
E EBCDIC character constant
X Hex character constant
B4 B3 GX M WX Bit and graphic constant not supported

Numeric Specification Characters
stored as packed decimal java.math.BigDecimal Java type
9 decimal digit
Z leading zero-suppressed decimal digit, displayed as blank
V assumed decimal point
. , / ' insertion characters
B blank character
S optional sign location
+ force positive or negative sign character
- force negative, blank positive sign character
$ default currency character
<char> alternative currency specification, <$>, <yen>
CR credit symbol
DB debit symbol
T I R Overpunch characters { through G
Y all zero-suppression, displayed as blank

Commoning Companion Attributes
stored as Date Java type
YYYY four-digit year
YY two-digit year
MM two-digit month
DD two-digit day-of-month
DDD three-digit day-of-year
Several methods are available to discover the formatting criteria in a Java-centric way using String.format(), java.text.DecimalFormat or java.text.DateFormat formatting classes (getStringFormat(), getDateFormat(), getDecimalFormat() and a way to determine beforehand whether they are likely to work on the PICTURE value (isString(), isDate(), isDecimal()
Methods are available for native Java programming to retrieve the base types used to store Picture data.
Internally hold Picture values in "object" field as either java.math.BigDecimal (numeric Pictures) or String (non-numeric Pictures

Author:

Heirloom Computing, Inc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Picture ZERO

Fields
Modifier and Type	Field and Description
`static Picture`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`Picture(java.math.BigDecimal value)` Constructor - construct a arithmetic Picture from a java.math.BigDecimal and a @PIC annotation
`Picture(java.lang.Object value)` Constructor - construct a Picture from an @PIC annotation and data
`Picture(Picture picture, java.math.BigDecimal value)` Constructor - construct a arithmetic Picture
`Picture(Picture picture, java.lang.Object value)` Constructor - construct a arithmetic Picture
`Picture(java.lang.String data)` Constructor - construct a Picture variable with specification only Note: can only be used to communicate the picture specification to other constructors and valueOf() of pictures
`Picture(java.lang.String pictureString, java.math.BigDecimal value)` Constructor - construct a arithmetic Picture from a java.math.BigDecimal without checking for validity
`Picture(java.lang.String pictureString, java.util.Date date)` Constructor - construct a arithmetic Picture
`Picture(java.lang.String pictureString, java.lang.Object data)` Constructor - construct a Picture from a pic spec and data when no annotation (@PIC) is available
`Picture(java.lang.String pictureString, java.lang.String data)` Constructor - construct a arithmetic Picture

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Picture`	`abs()` abs() - return abs/modulus/magnitude
`Picture`	`add(Picture b)` add(b) - return a new Picture object whose value is (this + b)
`java.math.BigDecimal`	`bigDecimalValue()` bigDecimalValue() - return BigDecimal from a (numeric) Picture number
`java.math.BigInteger`	`bigIntegerValue()` bigIntegerValue() - return a big integer from a Picture number
`boolean`	`booleanValue()` booleanValue() - return a (truncated) boolean from a Picture number or string
`byte`	`byteValue()` byteValue() - return a (truncated) byte from a Picture number
`int`	`charsConsumed()` return the number of chars consumed during conversion
`int`	`compareTo(java.lang.Object x)` compareTo - compare a Picture with a non-Picture
`Picture`	`divide(Picture b)` divide(b) - return a / b
`double`	`doubleValue()` doubleValue() - return a (truncated) double from a Picture number
`boolean`	`equals(java.lang.Object x)` equals - compare two Picture numbers for equality
`FixedBin`	`fixedBinValue()` fixedBinValue() - return a (truncated) FixedBin from a Picture number
`float`	`floatValue()` floatValue() - return a (truncated) float from a Picture number
`static Picture`	`fromBytes(byte[] bytes)` fromBytes() - create a Picture from a byte array (one that had been generated from toBytes())
`java.text.DateFormat`	`getDateFormat()` getDateFormat() - return the Java java.text.DateFormat object suitable for formatting this PIC.
`java.text.DecimalFormat`	`getDecimalFormat()` getDecimalFormat() - return the Java java.text.DecimalFormat object suitable for formatting this PIC.
`java.lang.Object`	`getObject()` getObject() - return the underlying Object this picture is based upon, either a String for character picture specifications, java.math.BigDecimal for numeric picture specifications or Date for picture specifications with the commonly date attribute.
`java.lang.String`	`getPicture()` getPicture() - return the original picture specification
`com.heirloomcomputing.epli.runtime.Picture.PictureSpec`	`getPictureSpec()` get internal PictureSpec of this Picture
`int`	`getSize()` to determine the "size in bytes if converted to a byte array" convert it to a byte array
`java.lang.String`	`getStringFormat()` getStringFormat() - return the Java Formatter specification suitable for use in Java String.format() or Formatter class methods to translate values into Strings following the PIC spec.
`int`	`hashCode()` hashcode of a pic is that of the underlying object
`int`	`intValue()` intValue() - return a (truncated) integer from a Picture number
`boolean`	`isDate()` isDate() - return true if this is a PICTURE specification with the DATE formatting attribute.
`boolean`	`isDecimal()` isDecimal() - return true if this is a PICTURE specification usable in numeric calculations (does not have A or X PIC chars).
`boolean`	`isString()` isString() - return true if this is a PICTURE specification usable containing A or X PIC chars.
`long`	`longValue()` longValue() - return a (truncated) long from a Picture number
`static void`	`main(java.lang.String[] args)` main - unit test for Picture
`Picture`	`multiply(Picture b)` multiply(b) - return a new Picture object whose value is (this * b)
`Picture`	`negate()` negate() - return a new Picture object whose value is (-this)
`static void`	`Reset()` reset the internationalization symbols used for format invoke after changing the LOCALE settings (e.g., EPLI.RuntimeOption("LOCALE=es_ES")
`short`	`shortValue()` shortValue() - return a (truncated) short from a Picture number
`int`	`size()` return the size in bytes if this Picture were to be converted with toBytes()
`Picture`	`subtract(Picture b)` subtract(b) - return a new Picture object whose value is (this - b)
`byte[]`	`toByteArray()` toByteArray - synonym for toBytes()
`byte[]`	`toBytes()` toBytes() - return a byte array representation of this picture
`java.lang.String`	`toRawString()` toRawString() - return a String representation the data only, without formating, of the Picture object
`java.lang.String`	`toString()` toString() - return a String representation of the invoking Picture object
`java.lang.String`	`toString(java.lang.String picSpec)` toString - return a String representation of the invoking Picture object
`static Picture`	`valueOf(java.math.BigDecimal b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(java.math.BigInteger b)` valueOf() - construct a Picture number from a java.math.BigInteger
`Picture`	`valueOf(BitN bs)` valueOf() - construct a Picture number from a BitN
`Picture`	`valueOf(java.lang.Boolean b)` valueOf() - construct a Picture number from a Boolean
`Picture`	`valueOf(byte i)` valueOf() - construct a Picture number from a byte
`static Picture`	`valueOf(java.lang.Byte b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(double d)` valueOf() - construct a Picture number from a double or float
`static Picture`	`valueOf(java.lang.Double b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(FixedBin f)` valueOf() - construct a Picture number from a FixedBin
`Picture`	`valueOf(float f)` valueOf() - construct a Picture number from a double or float
`static Picture`	`valueOf(java.lang.Float b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(int i)` valueOf() - construct a Picture number from an int
`static Picture`	`valueOf(java.lang.Integer b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(long i)` valueOf() - construct a Picture number from a long
`static Picture`	`valueOf(java.lang.Long b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(Picture pval)` valueOf() - construct a Picture number from another Picture
`Picture`	`valueOf(short i)` valueOf() - construct a Picture number from a short
`static Picture`	`valueOf(java.lang.Short b)` valueOf() - construct a Picture number from a java.math.BigDecimal
`Picture`	`valueOf(java.lang.String str)` valueOf() - duplicate a Picture but with a different value
`static Picture`	`valueOf(java.lang.String pic, java.math.BigInteger b)` valueOf() - construct a Picture number from a java.math.BigInteger
`static Picture`	`valueOf(java.lang.String pic, BitN bs)` valueOf() - construct a Picture number from a BitN
`static Picture`	`valueOf(java.lang.String pic, java.lang.Boolean b)` valueOf() - construct a Picture number from a Boolean
`static Picture`	`valueOf(java.lang.String pic, byte i)` valueOf() - construct a Picture number from a byte
`static Picture`	`valueOf(java.lang.String pic, java.util.Date value)` valueOf() - construct a Picture number from another Picture
`static Picture`	`valueOf(java.lang.String pic, double d)` valueOf() - construct a Picture number from a double or float
`static Picture`	`valueOf(java.lang.String pic, FixedBin f)` valueOf() - construct a Picture number from a FixedBin
`static Picture`	`valueOf(java.lang.String pic, float f)` valueOf() - construct a Picture number from a double or float
`static Picture`	`valueOf(java.lang.String pic, int i)` valueOf() - construct a Picture number from an int
`static Picture`	`valueOf(java.lang.String pic, long i)` valueOf() - construct a Picture number from a long
`static Picture`	`valueOf(java.lang.String pic, Picture pval)` valueOf() - construct a Picture number from another Picture
`static Picture`	`valueOf(java.lang.String pic, short i)` valueOf() - construct a Picture number from a short
`static Picture`	`valueOf(java.lang.String pictureString, java.lang.String str)` valueOf() - construct a Picture number from a string

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final Picture ZERO
```
- Constructor Detail
  - Picture
```
public Picture(java.lang.String data)
```
    Constructor - construct a Picture variable with specification only Note: can only be used to communicate the picture specification to other constructors and valueOf() of pictures
  - Picture
```
public Picture(java.lang.String pictureString,
               java.math.BigDecimal value)
```
    Constructor - construct a arithmetic Picture from a java.math.BigDecimal without checking for validity
    
    Parameters:
    
    packed - - set a numeric PICTURE specification and value Note: use static valueOf() to construct other numeric PICTUREs
  - Picture
```
public Picture(java.math.BigDecimal value)
```
    Constructor - construct a arithmetic Picture from a java.math.BigDecimal and a @PIC annotation
    
    Parameters:
    
    packed - - set a numeric PICTURE specification and value Note: use static valueOf() to construct other numeric PICTUREs
  - Picture
```
public Picture(Picture picture,
               java.math.BigDecimal value)
```
    Constructor - construct a arithmetic Picture
    
    Parameters:
    
    packed - - set a numeric PICTURE specification and value
  - Picture
```
public Picture(Picture picture,
               java.lang.Object value)
```
    Constructor - construct a arithmetic Picture
    
    Parameters:
    
    picture - - set a string PICTURE specification
    
    value - - and its value conforming to the pic spec
    
    Throws:
    
    CONVERSION - condition if the data does not conform with the specification
  - Picture
```
public Picture(java.lang.Object value)
```
    Constructor - construct a Picture from an @PIC annotation and data
    
    Parameters:
    
    value - - the picture value whose contents infer the PICTURE specification
    
    Throws:
    
    CONVERSION - condition if the data does not conform with the specification
  - Picture
```
public Picture(java.lang.String pictureString,
               java.lang.String data)
```
    Constructor - construct a arithmetic Picture
    
    Parameters:
    
    picture - - a string PICTURE specification
    
    data - - the value conforming to the PIC spec
    
    Throws:
    
    CONVERSION - condition if the data does not conform with the specification
  - Picture
```
public Picture(java.lang.String pictureString,
               java.lang.Object data)
```
    Constructor - construct a Picture from a pic spec and data when no annotation (@PIC) is available
    
    Parameters:
    
    picture - - a string PICTURE specification
    
    data - - PICTURE value
    
    Throws:
    
    CONVERSION - condition if the data does not conform with the specification
  - Picture
```
public Picture(java.lang.String pictureString,
               java.util.Date date)
```
    Constructor - construct a arithmetic Picture
    
    Parameters:
    
    date - - set a commonly date PICTURE specification and value
- Method Detail
  - valueOf
```
public static Picture valueOf(java.lang.String pictureString,
                              java.lang.String str)
```
    valueOf() - construct a Picture number from a string
    
    Parameters:
    
    pic - - a String of the picture specification is used to construct (may be null meaning infer the pic spec from the str)
    
    str - - a String value in the same format as returned by toString()
    
    Returns:
    
    a new numeric or string Picture, based on the specification
  - valueOf
```
public Picture valueOf(java.lang.String str)
```
    valueOf() - duplicate a Picture but with a different value
    
    Parameters:
    
    str - - a value value in the form of a String to be applied to this Picture
    
    Returns:
    
    a new numeric or string Picture, based on the specification
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              long i)
```
    valueOf() - construct a Picture number from a long
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    i - - a long value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(long i)
```
    valueOf() - construct a Picture number from a long
    
    Parameters:
    
    i - - a long value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              int i)
```
    valueOf() - construct a Picture number from an int
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    i - - an int value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(int i)
```
    valueOf() - construct a Picture number from an int
    
    Parameters:
    
    i - - an int value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              short i)
```
    valueOf() - construct a Picture number from a short
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    i - - a short value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(short i)
```
    valueOf() - construct a Picture number from a short
    
    Parameters:
    
    i - - a short value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              byte i)
```
    valueOf() - construct a Picture number from a byte
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    i - - a byte value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(byte i)
```
    valueOf() - construct a Picture number from a byte
    
    Parameters:
    
    i - - a byte value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              double d)
```
    valueOf() - construct a Picture number from a double or float
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    d - - a double value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(double d)
```
    valueOf() - construct a Picture number from a double or float
    
    Parameters:
    
    d - - a double value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              float f)
```
    valueOf() - construct a Picture number from a double or float
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    f - - a float value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(float f)
```
    valueOf() - construct a Picture number from a double or float
    
    Parameters:
    
    f - - a float value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              FixedBin f)
```
    valueOf() - construct a Picture number from a FixedBin
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    f - - a FixedBin value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(FixedBin f)
```
    valueOf() - construct a Picture number from a FixedBin
    
    Parameters:
    
    f - - a FixedBin value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              java.math.BigInteger b)
```
    valueOf() - construct a Picture number from a java.math.BigInteger
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    b - - a java.math.BigInteger value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.math.BigDecimal b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a java.math.BigDecimal value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Byte b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Byte
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Integer b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Integer
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Short b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Short
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Long b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Long
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Double b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Double
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.Float b)
```
    valueOf() - construct a Picture number from a java.math.BigDecimal
    
    Parameters:
    
    b - - a Float
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(java.math.BigInteger b)
```
    valueOf() - construct a Picture number from a java.math.BigInteger
    
    Parameters:
    
    b - - a java.math.BigInteger value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              java.lang.Boolean b)
```
    valueOf() - construct a Picture number from a Boolean
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    b - - a Boolean value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(java.lang.Boolean b)
```
    valueOf() - construct a Picture number from a Boolean
    
    Parameters:
    
    b - - a Boolean value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              BitN bs)
```
    valueOf() - construct a Picture number from a BitN
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    bs - - a BitN value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(BitN bs)
```
    valueOf() - construct a Picture number from a BitN
    
    Parameters:
    
    bs - - a BitN value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              Picture pval)
```
    valueOf() - construct a Picture number from another Picture
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    pval - - a Picture value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public static Picture valueOf(java.lang.String pic,
                              java.util.Date value)
```
    valueOf() - construct a Picture number from another Picture
    
    Parameters:
    
    pic - - the String format of the new Picture
    
    pval - - a Picture value
    
    Returns:
    
    a new Picture number
  - valueOf
```
public Picture valueOf(Picture pval)
```
    valueOf() - construct a Picture number from another Picture
    
    Parameters:
    
    pval - - the other Picture
    
    Returns:
    
    a new Picture number
  - fromBytes
```
public static Picture fromBytes(byte[] bytes)
```
    fromBytes() - create a Picture from a byte array (one that had been generated from toBytes())
    
    Parameters:
    
    bytes - - the byte array
    
    Returns:
    
    the byte array rep
  - size
```
public int size()
```
    return the size in bytes if this Picture were to be converted with toBytes()
    
    Returns:
    
    the size in bytes
  - charsConsumed
```
public int charsConsumed()
```
    return the number of chars consumed during conversion
    
    Returns:
    
    the size in bytes
  - isDate
```
public boolean isDate()
```
    isDate() - return true if this is a PICTURE specification with the DATE formatting attribute.
    
    Returns:
    
    true for DATE (non-numeric, non-string) PICTURE
  - isDecimal
```
public boolean isDecimal()
```
    isDecimal() - return true if this is a PICTURE specification usable in numeric calculations (does not have A or X PIC chars).
    
    Returns:
    
    true for a numeric (non-date, non-string) PICTURE
  - isString
```
public boolean isString()
```
    isString() - return true if this is a PICTURE specification usable containing A or X PIC chars.
    
    Returns:
    
    true for a string (non-numeric, non-date) PICTURE.
  - getPicture
```
public java.lang.String getPicture()
```
    getPicture() - return the original picture specification
    
    Returns:
    
    the picture specification
  - getPictureSpec
```
public com.heirloomcomputing.epli.runtime.Picture.PictureSpec getPictureSpec()
```
    get internal PictureSpec of this Picture
    
    Returns:
    
    PictureSpec - an internal representation of the picture
  - getStringFormat
```
public java.lang.String getStringFormat()
```
    getStringFormat() - return the Java Formatter specification suitable for use in Java String.format() or Formatter class methods to translate values into Strings following the PIC spec. Used in toString() for non-numeric Pictures
    
    Returns:
    
    the Java format specification.
    Note: this format may not produce an exact match to the PIC specification for decimal numbers.
    
    See Also:
    
    getDecimalFormat()
  - getDecimalFormat
```
public java.text.DecimalFormat getDecimalFormat()
```
    getDecimalFormat() - return the Java java.text.DecimalFormat object suitable for formatting this PIC. Used in toString() for numeric Pictures
    
    Returns:
    
    the Java format specification.
    Note: this format will not work for non-numeric Pictures.
    
    See Also:
    
    getStringFormat()
  - getDateFormat
```
public java.text.DateFormat getDateFormat()
```
    getDateFormat() - return the Java java.text.DateFormat object suitable for formatting this PIC. Used in toString() for date Pictures
    
    Returns:
    
    the Java format specification.
    Note: this format will not work for non-numeric Pictures.
    
    See Also:
    
    getStringFormat(), getDecimalFormat()
  - getObject
```
public java.lang.Object getObject()
```
    getObject() - return the underlying Object this picture is based upon, either a String for character picture specifications, java.math.BigDecimal for numeric picture specifications or Date for picture specifications with the commonly date attribute.
    
    Returns:
    
    the character data of this picture or null if the Picture is made up of packed or date components Note: use toString() to always get a string of the underlying object conforming to the picture specification
  - toString
```
public java.lang.String toString()
```
    toString() - return a String representation of the invoking Picture object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Picture number following the format
  - toRawString
```
public java.lang.String toRawString()
```
    toRawString() - return a String representation the data only, without formating, of the Picture object
    
    Returns:
    
    a String representation of this Picture in String or BigDecimal native format
  - toString
```
public java.lang.String toString(java.lang.String picSpec)
```
    toString - return a String representation of the invoking Picture object
    
    Parameters:
    
    picSpec - - use this to format the Picture instead of the one defined
    
    Returns:
    
    a String representation of this Picture number following the format
  - toBytes
```
public byte[] toBytes()
```
    toBytes() - return a byte array representation of this picture
    
    Returns:
    
    the byte array rep
  - toByteArray
```
public byte[] toByteArray()
```
    toByteArray - synonym for toBytes()
  - getSize
```
public int getSize()
```
    to determine the "size in bytes if converted to a byte array" convert it to a byte array
    
    Returns:
    
    size in bytes if converted to a byte array
  - bigDecimalValue
```
public java.math.BigDecimal bigDecimalValue()
```
    bigDecimalValue() - return BigDecimal from a (numeric) Picture number
    
    Returns:
    
    the real part as an int
    
    Throws:
    
    CONVERSION - Condition if PICTURE is not numeric
  - intValue
```
public int intValue()
```
    intValue() - return a (truncated) integer from a Picture number
    
    Specified by:
    
    intValue in class java.lang.Number
    
    Returns:
    
    the real part as an int
    
    Throws:
    
    CONVERSION - Condition if PICTURE is not numeric
  - shortValue
```
public short shortValue()
```
    shortValue() - return a (truncated) short from a Picture number
    
    Overrides:
    
    shortValue in class java.lang.Number
    
    Returns:
    
    the real part as an short
  - byteValue
```
public byte byteValue()
```
    byteValue() - return a (truncated) byte from a Picture number
    
    Overrides:
    
    byteValue in class java.lang.Number
    
    Returns:
    
    the real part as an byte
  - longValue
```
public long longValue()
```
    longValue() - return a (truncated) long from a Picture number
    
    Specified by:
    
    longValue in class java.lang.Number
    
    Returns:
    
    the real part as an long
  - bigIntegerValue
```
public java.math.BigInteger bigIntegerValue()
```
    bigIntegerValue() - return a big integer from a Picture number
    
    Returns:
    
    the pic value as a big int
    
    Throws:
    
    CONVERSION - Condition if PICTURE is not numeric
  - doubleValue
```
public double doubleValue()
```
    doubleValue() - return a (truncated) double from a Picture number
    
    Specified by:
    
    doubleValue in class java.lang.Number
    
    Returns:
    
    the real part as a double
  - floatValue
```
public float floatValue()
```
    floatValue() - return a (truncated) float from a Picture number
    
    Specified by:
    
    floatValue in class java.lang.Number
    
    Returns:
    
    the real part as a float
  - fixedBinValue
```
public FixedBin fixedBinValue()
```
    fixedBinValue() - return a (truncated) FixedBin from a Picture number
    
    Returns:
    
    the real part as a FixedBin
  - booleanValue
```
public boolean booleanValue()
```
    booleanValue() - return a (truncated) boolean from a Picture number or string
    
    Returns:
    
    the real part as a FixedBin
  - abs
```
public Picture abs()
```
    abs() - return abs/modulus/magnitude
    
    Returns:
    
    the absolute value of a complex number
  - negate
```
public Picture negate()
```
    negate() - return a new Picture object whose value is (-this)
    
    Returns:
    
    the negation of a (numeric) Picture
  - add
```
public Picture add(Picture b)
```
    add(b) - return a new Picture object whose value is (this + b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the sum of two Picture numbers
  - subtract
```
public Picture subtract(Picture b)
```
    subtract(b) - return a new Picture object whose value is (this - b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the difference of two Picture numbers
  - multiply
```
public Picture multiply(Picture b)
```
    multiply(b) - return a new Picture object whose value is (this * b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the result of multiplying two Picture numbers
  - divide
```
public Picture divide(Picture b)
```
    divide(b) - return a / b
    
    Parameters:
    
    b - Picture number as the divisor
    
    Returns:
    
    the Picture number dividend of this by the given divisor
  - equals
```
public boolean equals(java.lang.Object x)
```
    equals - compare two Picture numbers for equality
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    x - - a Picture number to compare
    
    Returns:
    
    false if contents are not equal to this Picture number
    
    Throws:
    
    CONVERSION - condition if x is not Picture
  - compareTo
```
public int compareTo(java.lang.Object x)
```
    compareTo - compare a Picture with a non-Picture
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.lang.Object>
    
    Parameters:
    
    x - - a Picture number to compare
    
    Returns:
    
    the value 0 if this Picture is equal to the argument Integer; a value less than 0 if this Picture is numerically less than the argument Picture; and a value greater than 0 if this Picture is numerically greater than the argument Picture (signed comparison).
    
    Throws:
    
    CONVERSION - condition if x is not Picture
  - hashCode
```
public int hashCode()
```
    hashcode of a pic is that of the underlying object
    
    Overrides:
    
    hashCode in class java.lang.Object
  - Reset
```
public static void Reset()
```
    reset the internationalization symbols used for format invoke after changing the LOCALE settings (e.g., EPLI.RuntimeOption("LOCALE=es_ES")
  - main
```
public static void main(java.lang.String[] args)
```
    main - unit test for Picture
    
    Parameters:
    
    args - - the real & imaginary part of operand "a" and "b", respectively

Class Picture

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

Constructor Detail

Picture

Picture

Picture

Picture

Picture

Picture

Picture

Picture

Picture

Method Detail

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

fromBytes

size

charsConsumed

isDate

isDecimal

isString

getPicture

getPictureSpec

getStringFormat

getDecimalFormat

getDateFormat

getObject

toString

toRawString

toString

toBytes

toByteArray

getSize

bigDecimalValue

intValue

shortValue

byteValue

longValue

bigIntegerValue

doubleValue

floatValue

fixedBinValue

booleanValue

abs

negate