@Generated public class Field133 extends Field implements java.io.Serializable
Model and parser for field 133 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 SRU2019
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_133
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 133
|
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
|
Constructor and Description |
---|
Field133()
Default constructor.
|
Field133(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field133(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 Field133 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field133 object.
|
static Field133 |
get(SwiftMessage msg)
Gets the first instance of Field133 in the given message.
|
static Field133 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field133> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field133 in the given message
an empty list is returned if none found.
|
static java.util.List<Field133> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field133 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 (Broadcast Indicator).
|
java.lang.String |
getComponent2()
Gets the component2 (Unsequenced Broadcast).
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Gets the component3 (Broadcast Issuer).
|
java.lang.String |
getComponent4()
Gets the component4 (Broadcast Number).
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 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 |
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 Field133 |
newInstance(Field133 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
|
Field133 |
setBroadcastIndicator(java.lang.String component1)
Set the Broadcast Indicator (component1).
|
Field133 |
setBroadcastIssuer(java.lang.String component3)
Set the Broadcast Issuer (component3).
|
Field133 |
setBroadcastNumber(java.lang.Number component4)
Set the Broadcast Number (component4) from a Number object.
|
Field133 |
setBroadcastNumber(java.lang.String component4)
Set the Broadcast Number (component4).
|
Field133 |
setComponent1(java.lang.String component1)
Set the component1 (Broadcast Indicator).
|
Field133 |
setComponent2(java.lang.String component2)
Set the component2 (Unsequenced Broadcast).
|
Field133 |
setComponent3(java.lang.String component3)
Set the component3 (Broadcast Issuer).
|
Field133 |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field133 |
setComponent4(java.lang.String component4)
Set the component4 (Broadcast Number).
|
Field133 |
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 validator pattern
|
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_133
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 Field133()
public Field133(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field133(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field133 newInstance(Field133 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
public java.lang.String getComponent1()
public java.lang.String getBroadcastIndicator()
public java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getUnsequencedBroadcast()
public java.lang.String getComponent3()
public java.lang.String getBroadcastIssuer()
public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getBroadcastNumber()
public java.lang.Number getBroadcastNumberAsNumber()
public Field133 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field133 setBroadcastIndicator(java.lang.String component1)
component1
- the Broadcast Indicator to setpublic Field133 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field133 setUnsequencedBroadcast(java.lang.String component2)
component2
- the Unsequenced Broadcast to setpublic Field133 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field133 setBroadcastIssuer(java.lang.String component3)
component3
- the Broadcast Issuer to setpublic Field133 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field133 setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field133 setBroadcastNumber(java.lang.String component4)
component4
- the Broadcast Number to setpublic Field133 setBroadcastNumber(java.lang.Number component4)
component4
- Number with the Broadcast Number content to setsetComponent4(java.lang.Number)
public java.lang.String getName()
public static Field133 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field133 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field133> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field133> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field133 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)