jPOS 1.6.1 API Documentation

org.jpos.util
Class FSDMsg

java.lang.Object
  extended by org.jpos.util.FSDMsg
All Implemented Interfaces:
Loggeable

public class FSDMsg
extends java.lang.Object
implements Loggeable

General purpose, Field Separator delimited message

Since:
1.4.7
Author:
Alejandro Revila, Mark Salter

Field Summary
static char EOF
           
static char FS
           
static char GS
           
static char RS
           
static char US
           
 
Constructor Summary
FSDMsg(java.lang.String basePath)
           
FSDMsg(java.lang.String basePath, java.lang.String baseSchema)
           
 
Method Summary
 void copy(java.lang.String fieldName, FSDMsg msg)
           
 void dump(java.io.PrintStream p, java.lang.String indent)
           
 java.lang.String get(java.lang.String fieldName)
           
 java.lang.String get(java.lang.String fieldName, java.lang.String def)
           
 java.lang.String getBasePath()
           
 java.lang.String getBaseSchema()
           
 byte[] getHeader()
           
 byte[] getHexBytes(java.lang.String name)
           
 java.lang.String getHexHeader()
           
 int getInt(java.lang.String name)
           
 int getInt(java.lang.String name, int def)
           
 java.util.Map getMap()
           
 boolean hasField(java.lang.String fieldName)
           
 boolean isSeparator(byte b)
           
 java.lang.String pack()
           
 void set(java.lang.String name, java.lang.String value)
           
 void setHeader(byte[] h)
           
 void setSeparator(java.lang.String separatorName, char separator)
           
 org.jdom.Element toXML()
           
 void unpack(byte[] b)
          parse message
 void unpack(java.io.InputStream is)
          parse message
 void unsetSeparator(java.lang.String separatorName)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FS

public static char FS

US

public static char US

RS

public static char RS

GS

public static char GS

EOF

public static char EOF
Constructor Detail

FSDMsg

public FSDMsg(java.lang.String basePath)
Parameters:
basePath - schema path

FSDMsg

public FSDMsg(java.lang.String basePath,
              java.lang.String baseSchema)
Parameters:
basePath - schema path
baseSchema - schema name
Method Detail

getBasePath

public java.lang.String getBasePath()

getBaseSchema

public java.lang.String getBaseSchema()

setSeparator

public void setSeparator(java.lang.String separatorName,
                         char separator)

unsetSeparator

public void unsetSeparator(java.lang.String separatorName)

unpack

public void unpack(java.io.InputStream is)
            throws java.io.IOException,
                   org.jdom.JDOMException,
                   java.net.MalformedURLException
parse message

Parameters:
is - input stream
Throws:
java.io.IOException
org.jdom.JDOMException
java.net.MalformedURLException

unpack

public void unpack(byte[] b)
            throws java.io.IOException,
                   org.jdom.JDOMException,
                   java.net.MalformedURLException
parse message

Parameters:
b - message image
Throws:
java.io.IOException
org.jdom.JDOMException
java.net.MalformedURLException
ISOException

pack

public java.lang.String pack()
                      throws org.jdom.JDOMException,
                             java.net.MalformedURLException,
                             java.io.IOException,
                             ISOException
Returns:
message string
Throws:
ISOException
org.jdom.JDOMException
java.net.MalformedURLException
java.io.IOException

isSeparator

public boolean isSeparator(byte b)

set

public void set(java.lang.String name,
                java.lang.String value)

setHeader

public void setHeader(byte[] h)

getHeader

public byte[] getHeader()

getHexHeader

public java.lang.String getHexHeader()

get

public java.lang.String get(java.lang.String fieldName)

get

public java.lang.String get(java.lang.String fieldName,
                            java.lang.String def)

copy

public void copy(java.lang.String fieldName,
                 FSDMsg msg)

getHexBytes

public byte[] getHexBytes(java.lang.String name)

getInt

public int getInt(java.lang.String name)

getInt

public int getInt(java.lang.String name,
                  int def)

toXML

public org.jdom.Element toXML()

getMap

public java.util.Map getMap()
Returns:
message's Map

dump

public void dump(java.io.PrintStream p,
                 java.lang.String indent)
Specified by:
dump in interface Loggeable

hasField

public boolean hasField(java.lang.String fieldName)

jPOS.org