@Generated public class Field336 extends Field implements java.io.Serializable
Model and parser for field 336 of a SWIFT MT message.
Subfields (components) Data types
String
Number
String
Structure definition
6!c5!n[36c]
6!S5!NS
SNS
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
CODES
Component number for the Codes subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DELIVERY_SUBSET_NAME
Component number for the Delivery Subset Name subfield
|
static java.lang.String |
F_336
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 336
|
static java.lang.Integer |
NUMBER_OF_MESSAGES
Component number for the Number Of Messages subfield
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field336()
Default constructor.
|
Field336(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field336(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's 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 Field336 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field336 object.
|
static Field336 |
get(SwiftMessage msg)
Gets the first instance of Field336 in the given message.
|
static Field336 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field336> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field336 in the given message
an empty list is returned if none found.
|
static java.util.List<Field336> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field336 from the given block
an empty list is returned if none found.
|
java.lang.String |
getCodes()
Gets the Codes (component3).
|
java.lang.String |
getComponent1()
Gets the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2
|
java.lang.Number |
getComponent2AsNumber()
Get the component2 as Number
|
java.lang.String |
getComponent3()
Gets the component3
|
java.lang.String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
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 |
getDeliverySubsetName()
Gets the Delivery Subset Name (component1).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getNumberOfMessages()
Gets the Number Of Messages (component2).
|
java.lang.Number |
getNumberOfMessagesAsNumber()
Get the Number Of Messages (component2) 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 Field336 |
newInstance(Field336 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() |
Field336 |
setCodes(java.lang.String component3)
Set the Codes (component3).
|
Field336 |
setComponent1(java.lang.String component1)
Set the component1.
|
Field336 |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field336 |
setComponent2(java.lang.String component2)
Set the component2.
|
Field336 |
setComponent3(java.lang.String component3)
Set the component3.
|
Field336 |
setDeliverySubsetName(java.lang.String component1)
Set the Delivery Subset Name (component1).
|
Field336 |
setNumberOfMessages(java.lang.Number component2)
Set the Number Of Messages (component2) from a Number object.
|
Field336 |
setNumberOfMessages(java.lang.String component2)
Set the Number Of Messages (component2).
|
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's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, 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_336
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DELIVERY_SUBSET_NAME
public static final java.lang.Integer NUMBER_OF_MESSAGES
public static final java.lang.Integer CODES
public Field336()
public Field336(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field336(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field336 newInstance(Field336 source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getDeliverySubsetName()
public Field336 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field336 setDeliverySubsetName(java.lang.String component1)
component1
- the Delivery Subset Name to setpublic java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getNumberOfMessages()
public java.lang.Number getNumberOfMessagesAsNumber()
public Field336 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field336 setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field336 setNumberOfMessages(java.lang.String component2)
component2
- the Number Of Messages to setpublic Field336 setNumberOfMessages(java.lang.Number component2)
component2
- Number with the Number Of Messages content to setsetComponent2(java.lang.Number)
public java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent3AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCodes()
public Field336 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field336 setCodes(java.lang.String component3)
component3
- the Codes to setpublic boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field336 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field336 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field336> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field336> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected 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 static Field336 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)