@Generated public class Field272 extends Field implements java.io.Serializable, DateContainer
Model and parser for field 272 of a SWIFT MT message.
Subfields (components) Data types
Calendar
String
Structure definition
<YYMMDDHHMM><?>
10!NS
US
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ABORT
Component number for the Abort subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_272
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 272.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
TIMESTAMP
Component number for the Timestamp subfield.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field272()
Default constructor.
|
Field272(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field272(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()
Deprecated.
Use
typesPattern() instead. |
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. |
java.util.Calendar |
date()
Returns the first component that can be converted to a Calendar
|
java.util.List<java.util.Calendar> |
dates()
Returns all components that can be converted to a Calendar
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field272 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field272 object.
|
static Field272 |
get(SwiftMessage msg)
Gets the first instance of Field272 in the given message.
|
static Field272 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
java.lang.String |
getAbort()
Gets the Abort (component 2).
|
static java.util.List<Field272> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field272 in the given message
an empty list is returned if none found.
|
static java.util.List<Field272> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field272 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Timestamp).
|
java.util.Calendar |
getComponent1AsCalendar()
Get the component 1 as Calendar
|
java.lang.String |
getComponent2()
Gets the component 2 (Abort).
|
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 |
getTimestamp()
Gets the Timestamp (component 1).
|
java.util.Calendar |
getTimestampAsCalendar()
Get the Timestamp (component 1) as Calendar
|
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 Field272 |
newInstance(Field272 source)
Copy constructor.
|
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern.
|
Field272 |
setAbort(java.lang.String component2)
Set the Abort (component 2).
|
Field272 |
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.
|
Field272 |
setComponent1(java.lang.String component1)
Set the component 1 (Timestamp).
|
Field272 |
setComponent2(java.lang.String component2)
Set the component 2 (Abort).
|
Field272 |
setTimestamp(java.util.Calendar component1)
Set the Timestamp (component 1) from a Calendar object.
|
Field272 |
setTimestamp(java.lang.String component1)
Set the Timestamp (component 1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Returns the field component types pattern.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, 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_272
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer TIMESTAMP
public static final java.lang.Integer ABORT
public Field272()
public Field272(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field272(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field272 newInstance(Field272 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 field@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String componentsPattern()
typesPattern()
instead.Field
typesPattern()
instead.componentsPattern
in class Field
Field.typesPattern()
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public 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.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.util.Calendar getComponent1AsCalendar()
public java.lang.String getTimestamp()
public java.util.Calendar getTimestampAsCalendar()
public java.lang.String getComponent2()
public java.lang.String getAbort()
public Field272 setComponent1(java.lang.String component1)
component1
- the Timestamp to setpublic Field272 setComponent1(java.util.Calendar component1)
component1
- the Calendar with the Timestamp content to setpublic Field272 setTimestamp(java.lang.String component1)
component1
- the Timestamp to setpublic Field272 setTimestamp(java.util.Calendar component1)
component1
- Calendar with the Timestamp content to setsetComponent1(java.util.Calendar)
public Field272 setComponent2(java.lang.String component2)
component2
- the Abort to setpublic Field272 setAbort(java.lang.String component2)
component2
- the Abort to setpublic java.util.List<java.util.Calendar> dates()
dates
in interface DateContainer
public java.util.Calendar date()
public java.lang.String getName()
public static Field272 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field272 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field272> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field272> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field272 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)