@Generated public class Field330 extends Field implements java.io.Serializable
Model and parser for field 330 of a SWIFT MT message.
Subfields (components) Data types
Number
Number
Number
Number
Number
Number
Structure definition
4!n6!n6!n6!n6!n1!n
4!N6!N6!N6!N6!N1!N
NNNNNN
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACK_REPLAY_INDICATOR
Component number for the ACK Replay Indicator subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_330
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
ISN
Component number for the ISN subfield
|
static java.lang.Integer |
ISN_NAK
Component number for the ISN NAK subfield
|
static java.lang.String |
NAME
Constant with the field name 330
|
static java.lang.Integer |
OSN
Component number for the OSN subfield
|
static java.lang.Integer |
OSN_NAK
Component number for the OSN NAK subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
SESSION_NUMBER
Component number for the Session Number subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field330()
Default constructor.
|
Field330(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field330(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentsPattern()
Returns the field components pattern
|
int |
componentsSize()
Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field330 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field330 object.
|
static Field330 |
get(SwiftMessage msg)
Gets the first instance of Field330 in the given message.
|
static Field330 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
java.lang.String |
getACKReplayIndicator()
Gets the ACK Replay Indicator (component 6).
|
java.lang.Number |
getACKReplayIndicatorAsNumber()
Get the ACK Replay Indicator (component 6) as Number
|
static java.util.List<Field330> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field330 in the given message
an empty list is returned if none found.
|
static java.util.List<Field330> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field330 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Session Number).
|
java.lang.Number |
getComponent1AsNumber()
Get the component 1 as Number
|
java.lang.String |
getComponent2()
Gets the component 2 (ISN).
|
java.lang.Number |
getComponent2AsNumber()
Get the component 2 as Number
|
java.lang.String |
getComponent3()
Gets the component 3 (ISN NAK).
|
java.lang.Number |
getComponent3AsNumber()
Get the component 3 as Number
|
java.lang.String |
getComponent4()
Gets the component 4 (OSN).
|
java.lang.Number |
getComponent4AsNumber()
Get the component 4 as Number
|
java.lang.String |
getComponent5()
Gets the component 5 (OSN NAK).
|
java.lang.Number |
getComponent5AsNumber()
Get the component 5 as Number
|
java.lang.String |
getComponent6()
Gets the component 6 (ACK Replay Indicator).
|
java.lang.Number |
getComponent6AsNumber()
Get the component 6 as Number
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getISN()
Gets the ISN (component 2).
|
java.lang.Number |
getISNAsNumber()
Get the ISN (component 2) as Number
|
java.lang.String |
getISNNAK()
Gets the ISN NAK (component 3).
|
java.lang.Number |
getISNNAKAsNumber()
Get the ISN NAK (component 3) as Number
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getOSN()
Gets the OSN (component 4).
|
java.lang.Number |
getOSNAsNumber()
Get the OSN (component 4) as Number
|
java.lang.String |
getOSNNAK()
Gets the OSN NAK (component 5).
|
java.lang.Number |
getOSNNAKAsNumber()
Get the OSN NAK (component 5) as Number
|
java.lang.String |
getSessionNumber()
Gets the Session Number (component 1).
|
java.lang.Number |
getSessionNumberAsNumber()
Get the Session Number (component 1) as Number
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueDisplay(int component,
java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.
|
boolean |
isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
|
boolean |
isOptional(int component)
Given a component number it returns true if the component is optional,
regardless of the field being mandatory in a particular message.
Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set. |
static Field330 |
newInstance(Field330 source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern
|
Field330 |
setACKReplayIndicator(java.lang.Number component6)
Set the ACK Replay Indicator (component6) from a Number object.
|
Field330 |
setACKReplayIndicator(java.lang.String component6)
Set the ACK Replay Indicator (component6).
|
Field330 |
setComponent1(java.lang.Number component1)
Set the component1 from a Number object.
|
Field330 |
setComponent1(java.lang.String component1)
Set the component1 (Session Number).
|
Field330 |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field330 |
setComponent2(java.lang.String component2)
Set the component2 (ISN).
|
Field330 |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field330 |
setComponent3(java.lang.String component3)
Set the component3 (ISN NAK).
|
Field330 |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field330 |
setComponent4(java.lang.String component4)
Set the component4 (OSN).
|
Field330 |
setComponent5(java.lang.Number component5)
Set the component5 from a Number object.
|
Field330 |
setComponent5(java.lang.String component5)
Set the component5 (OSN NAK).
|
Field330 |
setComponent6(java.lang.Number component6)
Set the component6 from a Number object.
|
Field330 |
setComponent6(java.lang.String component6)
Set the component6 (ACK Replay Indicator).
|
Field330 |
setISN(java.lang.Number component2)
Set the ISN (component2) from a Number object.
|
Field330 |
setISN(java.lang.String component2)
Set the ISN (component2).
|
Field330 |
setISNNAK(java.lang.Number component3)
Set the ISN NAK (component3) from a Number object.
|
Field330 |
setISNNAK(java.lang.String component3)
Set the ISN NAK (component3).
|
Field330 |
setOSN(java.lang.Number component4)
Set the OSN (component4) from a Number object.
|
Field330 |
setOSN(java.lang.String component4)
Set the OSN (component4).
|
Field330 |
setOSNNAK(java.lang.Number component5)
Set the OSN NAK (component5) from a Number object.
|
Field330 |
setOSNNAK(java.lang.String component5)
Set the OSN NAK (component5).
|
Field330 |
setSessionNumber(java.lang.Number component1)
Set the Session Number (component1) from a Number object.
|
Field330 |
setSessionNumber(java.lang.String component1)
Set the Session Number (component1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_330
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer SESSION_NUMBER
public static final java.lang.Integer ISN
public static final java.lang.Integer ISN_NAK
public static final java.lang.Integer OSN
public static final java.lang.Integer OSN_NAK
public static final java.lang.Integer ACK_REPLAY_INDICATOR
public Field330()
public Field330(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field330(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field330 newInstance(Field330 source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
getValueDisplay
in class Field
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is usedjava.lang.IllegalArgumentException
- if component number is invalid for the fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
protected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public java.lang.String getComponent1()
public java.lang.Number getComponent1AsNumber()
public java.lang.String getSessionNumber()
public java.lang.Number getSessionNumberAsNumber()
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getISN()
public java.lang.Number getISNAsNumber()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getISNNAK()
public java.lang.Number getISNNAKAsNumber()
public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getOSN()
public java.lang.Number getOSNAsNumber()
public java.lang.String getComponent5()
public java.lang.Number getComponent5AsNumber()
public java.lang.String getOSNNAK()
public java.lang.Number getOSNNAKAsNumber()
public java.lang.String getComponent6()
public java.lang.Number getComponent6AsNumber()
public java.lang.String getACKReplayIndicator()
public java.lang.Number getACKReplayIndicatorAsNumber()
public Field330 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field330 setComponent1(java.lang.Number component1)
component1
- the Number with the component1 content to setsetComponent1(String)
public Field330 setSessionNumber(java.lang.String component1)
component1
- the Session Number to setpublic Field330 setSessionNumber(java.lang.Number component1)
component1
- Number with the Session Number content to setsetComponent1(java.lang.Number)
public Field330 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field330 setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field330 setISN(java.lang.String component2)
component2
- the ISN to setpublic Field330 setISN(java.lang.Number component2)
component2
- Number with the ISN content to setsetComponent2(java.lang.Number)
public Field330 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field330 setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field330 setISNNAK(java.lang.String component3)
component3
- the ISN NAK to setpublic Field330 setISNNAK(java.lang.Number component3)
component3
- Number with the ISN NAK content to setsetComponent3(java.lang.Number)
public Field330 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field330 setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field330 setOSN(java.lang.String component4)
component4
- the OSN to setpublic Field330 setOSN(java.lang.Number component4)
component4
- Number with the OSN content to setsetComponent4(java.lang.Number)
public Field330 setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field330 setComponent5(java.lang.Number component5)
component5
- the Number with the component5 content to setsetComponent5(String)
public Field330 setOSNNAK(java.lang.String component5)
component5
- the OSN NAK to setpublic Field330 setOSNNAK(java.lang.Number component5)
component5
- Number with the OSN NAK content to setsetComponent5(java.lang.Number)
public Field330 setComponent6(java.lang.String component6)
component6
- the component6 to setpublic Field330 setComponent6(java.lang.Number component6)
component6
- the Number with the component6 content to setsetComponent6(String)
public Field330 setACKReplayIndicator(java.lang.String component6)
component6
- the ACK Replay Indicator to setpublic Field330 setACKReplayIndicator(java.lang.Number component6)
component6
- Number with the ACK Replay Indicator content to setsetComponent6(java.lang.Number)
public java.lang.String getName()
public static Field330 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field330 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field330> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field330> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field330 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)