@Generated public class Field137 extends Field implements Serializable
Character
String
String
Number
Modifier and Type | Field and Description |
---|---|
static Integer |
BROADCAST_INITIATOR
Component number for the Broadcast Initiator subfield
|
static Integer |
BROADCAST_ISSUER
Component number for the Broadcast Issuer subfield
|
static Integer |
BROADCAST_NUMBER
Component number for the Broadcast Number subfield
|
static String |
COMPONENTS_PATTERN |
static String |
F_137
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 137
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
UNSEQUENCED_BROADCAST
Component number for the Unsequenced Broadcast subfield
|
components
Constructor and Description |
---|
Field137()
Default constructor.
|
Field137(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 |
---|---|
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 |
get(SwiftMessage msg)
Get the first instance of Field137 in the given message.
|
static Field137 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field137> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field137 in the given message
an empty list is returned if none found.
|
static List<Field137> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field137 from the given block
an empty list is returned if none found.
|
String |
getBroadcastInitiator()
Get the Broadcast Initiator (component1).
|
String |
getBroadcastIssuer()
Get the Broadcast Issuer (component3).
|
String |
getBroadcastNumber()
Get the Broadcast Number (component4).
|
Number |
getBroadcastNumberAsNumber()
Get the Broadcast Number (component4) as Number
|
String |
getComponent1()
Get the component1
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getUnsequencedBroadcast()
Get the Unsequenced Broadcast (component2).
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field137 |
setBroadcastInitiator(String component1)
Set the Broadcast Initiator (component1).
|
Field137 |
setBroadcastIssuer(String component3)
Set the Broadcast Issuer (component3).
|
Field137 |
setBroadcastNumber(Number component4)
Set the Broadcast Number (component4) from a Number object.
|
Field137 |
setBroadcastNumber(String component4)
Set the Broadcast Number (component4).
|
Field137 |
setComponent1(String component1)
Set the component1.
|
Field137 |
setComponent2(String component2)
Set the component2.
|
Field137 |
setComponent3(String component3)
Set the component3.
|
Field137 |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field137 |
setComponent4(String component4)
Set the component4.
|
Field137 |
setUnsequencedBroadcast(String component2)
Set the Unsequenced Broadcast (component2).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
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, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_137
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer BROADCAST_INITIATOR
public static final Integer UNSEQUENCED_BROADCAST
public static final Integer BROADCAST_ISSUER
public static final Integer BROADCAST_NUMBER
public Field137()
public Field137(String value)
value
- complete field value including separators and CRLFpublic Field137(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field137 newInstance(Field137 source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
public String getBroadcastInitiator()
public Field137 setComponent1(String component1)
component1
- the component1 to setpublic Field137 setBroadcastInitiator(String component1)
component1
- the Broadcast Initiator to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getUnsequencedBroadcast()
public Field137 setComponent2(String component2)
component2
- the component2 to setpublic Field137 setUnsequencedBroadcast(String component2)
component2
- the Unsequenced Broadcast to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getBroadcastIssuer()
public Field137 setComponent3(String component3)
component3
- the component3 to setpublic Field137 setBroadcastIssuer(String component3)
component3
- the Broadcast Issuer to setpublic String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getBroadcastNumber()
public Number getBroadcastNumberAsNumber()
null
if cannot be convertedpublic Field137 setComponent4(String component4)
component4
- the component4 to setpublic Field137 setComponent4(Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field137 setBroadcastNumber(String component4)
component4
- the Broadcast Number to setpublic Field137 setBroadcastNumber(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 String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final 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 List<Field137> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static 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 String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)