jPOS 1.6.7 API Documentation

org.jpos.iso
Class ISOBitMap

java.lang.Object
  extended by org.jpos.iso.ISOComponent
      extended by org.jpos.iso.ISOBitMap
All Implemented Interfaces:
java.lang.Cloneable

public class ISOBitMap
extends ISOComponent
implements java.lang.Cloneable

implements Leaf for Bitmap field

Version:
$Id: ISOBitMap.java 2854 2010-01-02 10:34:31Z apr $
Author:
apr@cs.com.uy
See Also:
ISOComponent

Constructor Summary
ISOBitMap(int n)
           
ISOBitMap(int n, java.util.BitSet v)
           
 
Method Summary
 void dump(java.io.PrintStream p, java.lang.String indent)
          dump this field to PrintStream.
 java.lang.Object getKey()
          valid on Leafs only.
 java.lang.Object getValue()
          valid on Leafs only.
 byte[] pack()
          not available on Leaf - always throw ISOException
 void setFieldNumber(int fieldNumber)
          changes this Component field number
Use with care, this method does not change any reference held by a Composite.
 void setValue(java.lang.Object obj)
           
 int unpack(byte[] b)
          not available on Leaf - always throw ISOException
 void unpack(java.io.InputStream in)
          not available on Leaf - always throw ISOException
 
Methods inherited from class org.jpos.iso.ISOComponent
getBytes, getChildren, getComposite, getMaxField, pack, set, unset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ISOBitMap

public ISOBitMap(int n)
Parameters:
n - - the FieldNumber

ISOBitMap

public ISOBitMap(int n,
                 java.util.BitSet v)
Parameters:
n - - fieldNumber
v - - field value (Bitset)
See Also:
BitSet
Method Detail

setFieldNumber

public void setFieldNumber(int fieldNumber)
changes this Component field number
Use with care, this method does not change any reference held by a Composite.

Specified by:
setFieldNumber in class ISOComponent
Parameters:
fieldNumber - new field number

pack

public byte[] pack()
            throws ISOException
not available on Leaf - always throw ISOException

Specified by:
pack in class ISOComponent
Throws:
ISOException

unpack

public int unpack(byte[] b)
           throws ISOException
not available on Leaf - always throw ISOException

Specified by:
unpack in class ISOComponent
Throws:
ISOException

unpack

public void unpack(java.io.InputStream in)
            throws ISOException
not available on Leaf - always throw ISOException

Specified by:
unpack in class ISOComponent
Throws:
ISOException

getKey

public java.lang.Object getKey()
Description copied from class: ISOComponent
valid on Leafs only. The value returned is used by ISOMsg as a key to this field.

Overrides:
getKey in class ISOComponent
Returns:
Object representing this field number

getValue

public java.lang.Object getValue()
Description copied from class: ISOComponent
valid on Leafs only.

Overrides:
getValue in class ISOComponent
Returns:
Object representing this field value

setValue

public void setValue(java.lang.Object obj)
              throws ISOException
Specified by:
setValue in class ISOComponent
Parameters:
obj - - Object representing this field value
Throws:
ISOException

dump

public void dump(java.io.PrintStream p,
                 java.lang.String indent)
dump this field to PrintStream. The output is sorta XML, intended to be easily parsed.

Specified by:
dump in class ISOComponent
Parameters:
p - - print stream
indent - - optional indent string

jPOS.org