@Generated public class Field137 extends Field implements java.io.Serializable
Model and parser for field 137 of a SWIFT MT message.
Subfields (components) Data types
Character
String
String
Number
Structure definition
1a3!x<CC>4!n
c3!S<CC>N
cSKN
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
BROADCAST_INDICATOR
Component number for the Broadcast Indicator subfield
|
static java.lang.Integer |
BROADCAST_ISSUER
Component number for the Broadcast Issuer subfield
|
static java.lang.Integer |
BROADCAST_NUMBER
Component number for the Broadcast Number subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_137
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 137
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
UNSEQUENCED_BROADCAST
Component number for the Unsequenced Broadcast subfield
|
components
Constructor and Description |
---|
Field137()
Default constructor.
|
Field137(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field137(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 Field137 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field137 object.
|
static Field137 |
get(SwiftMessage msg)
Gets the first instance of Field137 in the given message.
|
static Field137 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field137> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field137 in the given message
an empty list is returned if none found.
|
static java.util.List<Field137> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field137 from the given block
an empty list is returned if none found.
|
java.lang.String |
getBroadcastIndicator()
Gets the Broadcast Indicator (component1).
|
java.lang.String |
getBroadcastIssuer()
Gets the Broadcast Issuer (component3).
|
java.lang.String |
getBroadcastNumber()
Gets the Broadcast Number (component4).
|
java.lang.Number |
getBroadcastNumberAsNumber()
Get the Broadcast Number (component4) as Number
|
java.lang.String |
getComponent1()
Gets the component1
|
java.lang.String |
getComponent2()
Gets the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Gets the component3
|
java.lang.String |
getComponent4()
Gets the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 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 |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getUnsequencedBroadcast()
Gets the Unsequenced Broadcast (component2).
|
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 Field137 |
newInstance(Field137 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() |
Field137 |
setBroadcastIndicator(java.lang.String component1)
Set the Broadcast Indicator (component1).
|
Field137 |
setBroadcastIssuer(java.lang.String component3)
Set the Broadcast Issuer (component3).
|
Field137 |
setBroadcastNumber(java.lang.Number component4)
Set the Broadcast Number (component4) from a Number object.
|
Field137 |
setBroadcastNumber(java.lang.String component4)
Set the Broadcast Number (component4).
|
Field137 |
setComponent1(java.lang.String component1)
Set the component1.
|
Field137 |
setComponent2(java.lang.String component2)
Set the component2.
|
Field137 |
setComponent3(java.lang.String component3)
Set the component3.
|
Field137 |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field137 |
setComponent4(java.lang.String component4)
Set the component4.
|
Field137 |
setUnsequencedBroadcast(java.lang.String component2)
Set the Unsequenced Broadcast (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_137
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer BROADCAST_INDICATOR
public static final java.lang.Integer UNSEQUENCED_BROADCAST
public static final java.lang.Integer BROADCAST_ISSUER
public static final java.lang.Integer BROADCAST_NUMBER
public Field137()
public Field137(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field137(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 Field137 newInstance(Field137 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()
public java.lang.String getBroadcastIndicator()
public Field137 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field137 setBroadcastIndicator(java.lang.String component1)
component1
- the Broadcast Indicator to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getUnsequencedBroadcast()
public Field137 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field137 setUnsequencedBroadcast(java.lang.String component2)
component2
- the Unsequenced Broadcast to setpublic java.lang.String getComponent3()
public java.lang.String getBroadcastIssuer()
public Field137 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field137 setBroadcastIssuer(java.lang.String component3)
component3
- the Broadcast Issuer to setpublic java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getBroadcastNumber()
public java.lang.Number getBroadcastNumberAsNumber()
public Field137 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field137 setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field137 setBroadcastNumber(java.lang.String component4)
component4
- the Broadcast Number to setpublic Field137 setBroadcastNumber(java.lang.Number component4)
component4
- Number with the Broadcast Number content to setsetComponent4(java.lang.Number)
public 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 Field137 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field137 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field137> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field137> 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 Field137 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)