@Generated public class Field14S extends Field implements java.io.Serializable
Model and parser for field 14S of a SWIFT MT message.
Subfields (components) Data types
String
Number
Calendar
String
Structure definition
3!a2!n[/<HHMM>/4!c]
SN[/<HHMM>/S]
SNHS
This class complies with standard release SRU2019
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_14S
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
LOCATION
Component number for the Location subfield
|
static java.lang.String |
NAME
Constant with the field name 14S
|
static java.lang.Integer |
NUMBER
Component number for the Number subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
SOURCE
Component number for the Source subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
TIME
Component number for the Time subfield
|
Constructor and Description |
---|
Field14S()
Default constructor.
|
Field14S(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field14S(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 Field14S |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field14S object.
|
static Field14S |
get(SwiftMessage msg)
Gets the first instance of Field14S in the given message.
|
static Field14S |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field14S> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field14S in the given message
an empty list is returned if none found.
|
static java.util.List<Field14S> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field14S from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component1 (Source).
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2 (Number).
|
java.lang.Number |
getComponent2AsNumber()
Get the component2 as Number
|
java.lang.String |
getComponent3()
Gets the component3 (Time).
|
java.util.Calendar |
getComponent3AsCalendar()
Get the component3 as Calendar
|
java.lang.String |
getComponent4()
Gets the component4 (Location).
|
java.lang.String |
getComponent4AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getLocation()
Gets the Location (component4).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getNumber()
Gets the Number (component2).
|
java.lang.Number |
getNumberAsNumber()
Get the Number (component2) as Number
|
java.lang.String |
getSource()
Gets the Source (component1).
|
java.lang.String |
getTime()
Gets the Time (component3).
|
java.util.Calendar |
getTimeAsCalendar()
Get the Time (component3) 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 Field14S |
newInstance(Field14S 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
|
Field14S |
setComponent1(java.lang.String component1)
Set the component1 (Source).
|
Field14S |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field14S |
setComponent2(java.lang.String component2)
Set the component2 (Number).
|
Field14S |
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.
|
Field14S |
setComponent3(java.lang.String component3)
Set the component3 (Time).
|
Field14S |
setComponent4(java.lang.String component4)
Set the component4 (Location).
|
Field14S |
setLocation(java.lang.String component4)
Set the Location (component4).
|
Field14S |
setNumber(java.lang.Number component2)
Set the Number (component2) from a Number object.
|
Field14S |
setNumber(java.lang.String component2)
Set the Number (component2).
|
Field14S |
setSource(java.lang.String component1)
Set the Source (component1).
|
Field14S |
setTime(java.util.Calendar component3)
Set the Time (component3) from a Calendar object.
|
Field14S |
setTime(java.lang.String component3)
Set the Time (component3).
|
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_14S
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer SOURCE
public static final java.lang.Integer NUMBER
public static final java.lang.Integer TIME
public static final java.lang.Integer LOCATION
public Field14S()
public Field14S(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field14S(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field14S newInstance(Field14S 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()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getSource()
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getNumber()
public java.lang.Number getNumberAsNumber()
public java.lang.String getComponent3()
public java.util.Calendar getComponent3AsCalendar()
public java.lang.String getTime()
public java.util.Calendar getTimeAsCalendar()
public java.lang.String getComponent4()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent4AsString()
Field.getComponent(int)
insteadpublic java.lang.String getLocation()
public Field14S setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field14S setSource(java.lang.String component1)
component1
- the Source to setpublic Field14S setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field14S setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field14S setNumber(java.lang.String component2)
component2
- the Number to setpublic Field14S setNumber(java.lang.Number component2)
component2
- Number with the Number content to setsetComponent2(java.lang.Number)
public Field14S setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field14S setComponent3(java.util.Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field14S setTime(java.lang.String component3)
component3
- the Time to setpublic Field14S setTime(java.util.Calendar component3)
component3
- Calendar with the Time content to setsetComponent3(java.util.Calendar)
public Field14S setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field14S setLocation(java.lang.String component4)
component4
- the Location to setpublic java.lang.String getName()
public static Field14S get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field14S get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field14S> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field14S> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field14S fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)