com.prowidesoftware.swift.model
Class SwiftValueBlock

java.lang.Object
  extended by com.prowidesoftware.swift.model.SwiftBlock
      extended by com.prowidesoftware.swift.model.SwiftValueBlock
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
SwiftBlock1, SwiftBlock2

public abstract class SwiftValueBlock
extends SwiftBlock
implements java.io.Serializable

Base class for SWIFT blocks that contain its fields concatenated as a single fixed length value; blocks 1 and 2.
This is an abstract class so specific block classes for each block should be instantiated.

Since:
4.0
Version:
$Id: SwiftValueBlock.java,v 1.1.1.1 2013/04/10 17:04:50 mgriffa Exp $
Author:
www.prowidesoftware.com
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.prowidesoftware.swift.model.SwiftBlock
blockType, id, input, output, unparsedTexts
 
Constructor Summary
protected SwiftValueBlock()
          Default constructor, shouldn't be used normally.
 
Method Summary
 java.lang.String getBlockValue()
          This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
 java.lang.String getValue()
          This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
protected  java.lang.String getValuePart(java.lang.String value, int start, int size)
          returns a fragment of the block value received (or null if value is not large enough).
This method is used in derived classes to get value fragments.
 boolean isEmpty()
          Tells if the block contains at least one field.
 void setBlockValue(java.lang.String value)
          This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException
 void setValue(java.lang.String value)
          This method should be overwritten by subclasses and proper parsing be done to set specific values of the block, calling this method will throw a java.lang.UnsupportedOperationException
 int size()
          Tells the block's string value size (in chars).
NOTICE this does not return the actual number of fields set because value blocks are mostly fixed length.
 
Methods inherited from class com.prowidesoftware.swift.model.SwiftBlock
equals, getBlockType, getId, getInput, getName, getNumber, getOutput, getUnparsedTexts, getUnparsedTextsSize, hashCode, isTagBlock, setBlockName, setBlockNumber, setBlockType, setId, setInput, setOutput, setUnparsedTexts, toString, unparsedTextAddText, unparsedTextAddText, unparsedTextGetAsMessage, unparsedTextGetText, unparsedTextIsMessage, unparsedTextVerify
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SwiftValueBlock

protected SwiftValueBlock()
Default constructor, shouldn't be used normally. present only for subclasses

Method Detail

getBlockValue

public java.lang.String getBlockValue()
This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Returns:
N/A

getValue

public java.lang.String getValue()
This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Returns:
the blocks value as a single string

setValue

public void setValue(java.lang.String value)
This method should be overwritten by subclasses and proper parsing be done to set specific values of the block, calling this method will throw a java.lang.UnsupportedOperationException

Parameters:
value - the blocks value as a single string

setBlockValue

public void setBlockValue(java.lang.String value)
This method should be overwritten by subclasses, calling this method will throw a java.lang.UnsupportedOperationException

Parameters:
value - unused

isEmpty

public boolean isEmpty()
Tells if the block contains at least one field. This method must be called on specific subclasses, calling it for SwiftValueBlock will throw a java.lang.UnsupportedOperationException

Returns:
true if getValue returns a non null object

size

public int size()
Tells the block's string value size (in chars).
NOTICE this does not return the actual number of fields set because value blocks are mostly fixed length. This method must be called on specific subclasses, calling it for SwiftValueBlock will throw a java.lang.UnsupportedOperationException

Returns:
the size of the value or zero if value is null

getValuePart

protected java.lang.String getValuePart(java.lang.String value,
                                        int start,
                                        int size)
returns a fragment of the block value received (or null if value is not large enough).
This method is used in derived classes to get value fragments.

Parameters:
value - the full block value
start - the starting point of the fragment in the big block value
size - the fragment size
Returns:
the value fragment or null if value is not large enough