@Generated public class Field13C extends Field implements java.io.Serializable
Model and parser for field 13C of a SWIFT MT message.
Subfields (components) Data types
String
Calendar
Character
Calendar
Structure definition
/8c/<HHMM><SIGN><OFFSET>
/S/<HHMM><SIGN><OFFSET>
SHGO
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
CODE
Component number for the Code subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.String |
F_13C
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 13C.
|
static java.lang.Integer |
OFFSET
Deprecated.
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
SIGN
Component number for the Sign subfield.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
TIME
Deprecated.
|
static java.lang.Integer |
TIME_INDICATION
Component number for the Time Indication subfield.
|
static java.lang.Integer |
TIME_OFFSET
Component number for the Time Offset subfield.
|
static java.lang.String |
TYPES_PATTERN
Types pattern.
|
components
Constructor and Description |
---|
Field13C()
Default constructor.
|
Field13C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field13C(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.
|
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.
|
static Field13C |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field13C object.
|
static Field13C |
get(SwiftMessage msg)
Gets the first instance of Field13C in the given message.
|
static Field13C |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field13C> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field13C in the given message
an empty list is returned if none found.
|
static java.util.List<Field13C> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field13C from the given block
an empty list is returned if none found.
|
java.lang.String |
getCode()
Gets the Code (component 1).
|
java.lang.String |
getComponent1()
Gets the component 1 (Code).
|
java.lang.String |
getComponent2()
Gets the component 2 (Time Indication).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Sign).
|
java.lang.String |
getComponent4()
Gets the component 4 (Time Offset).
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component 4 as Calendar
|
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 |
getOffset()
Deprecated.
|
java.util.Calendar |
getOffsetAsCalendar()
Deprecated.
|
java.lang.String |
getSign()
Gets the Sign (component 3).
|
java.lang.String |
getTime()
Deprecated.
|
java.util.Calendar |
getTimeAsCalendar()
Deprecated.
|
java.lang.String |
getTimeIndication()
Gets the Time Indication (component 2).
|
java.util.Calendar |
getTimeIndicationAsCalendar()
Get the Time Indication (component 2) as Calendar
|
java.lang.String |
getTimeOffset()
Gets the Time Offset (component 4).
|
java.util.Calendar |
getTimeOffsetAsCalendar()
Get the Time Offset (component 4) 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 Field13C |
newInstance(Field13C 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
|
Field13C |
setCode(java.lang.String component1)
Set the Code (component 1).
|
Field13C |
setComponent1(java.lang.String component1)
Set the component 1 (Code).
|
Field13C |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field13C |
setComponent2(java.lang.String component2)
Set the component 2 (Time Indication).
|
Field13C |
setComponent3(java.lang.String component3)
Set the component 3 (Sign).
|
Field13C |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field13C |
setComponent4(java.lang.String component4)
Set the component 4 (Time Offset).
|
Field13C |
setOffset(java.util.Calendar component4)
Deprecated.
|
Field13C |
setOffset(java.lang.String component4)
Deprecated.
|
Field13C |
setSign(java.lang.String component3)
Set the Sign (component 3).
|
Field13C |
setTime(java.util.Calendar component2)
Deprecated.
|
Field13C |
setTime(java.lang.String component2)
Deprecated.
|
Field13C |
setTimeIndication(java.util.Calendar component2)
Set the Time Indication (component 2) from a Calendar object.
|
Field13C |
setTimeIndication(java.lang.String component2)
Set the Time Indication (component 2).
|
Field13C |
setTimeOffset(java.util.Calendar component4)
Set the Time Offset (component 4) from a Calendar object.
|
Field13C |
setTimeOffset(java.lang.String component4)
Set the Time Offset (component 4).
|
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
This method returns a letter representing the type for each component in the Field.
|
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_13C
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN
,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer CODE
public static final java.lang.Integer TIME_INDICATION
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer TIME
TIME_INDICATION
public static final java.lang.Integer SIGN
public static final java.lang.Integer TIME_OFFSET
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer OFFSET
TIME_OFFSET
public Field13C()
public Field13C(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field13C(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field13C newInstance(Field13C 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 final java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
typesPattern()
public final java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
TYPES_PATTERN
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.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.lang.String getCode()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getTimeIndication()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getTime()
getTimeIndication()
public java.util.Calendar getTimeIndicationAsCalendar()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.util.Calendar getTimeAsCalendar()
getTimeIndicationAsCalendar()
public java.lang.String getComponent3()
public java.lang.String getSign()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getTimeOffset()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getOffset()
getTimeOffset()
public java.util.Calendar getTimeOffsetAsCalendar()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.util.Calendar getOffsetAsCalendar()
getTimeOffsetAsCalendar()
public Field13C setComponent1(java.lang.String component1)
component1
- the Code to setpublic Field13C setCode(java.lang.String component1)
component1
- the Code to setpublic Field13C setComponent2(java.lang.String component2)
component2
- the Time Indication to setpublic Field13C setComponent2(java.util.Calendar component2)
component2
- the Calendar with the Time Indication content to setpublic Field13C setTimeIndication(java.lang.String component2)
component2
- the Time Indication to setpublic Field13C setTimeIndication(java.util.Calendar component2)
component2
- Calendar with the Time Indication content to setsetComponent2(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field13C setTime(java.lang.String component2)
component2
- the Time Indication to setsetTimeIndication(String)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field13C setTime(java.util.Calendar component2)
component2
- Calendar with the Time Indication content to setsetComponent2(java.util.Calendar)
public Field13C setComponent3(java.lang.String component3)
component3
- the Sign to setpublic Field13C setSign(java.lang.String component3)
component3
- the Sign to setpublic Field13C setComponent4(java.lang.String component4)
component4
- the Time Offset to setpublic Field13C setComponent4(java.util.Calendar component4)
component4
- the Calendar with the Time Offset content to setpublic Field13C setTimeOffset(java.lang.String component4)
component4
- the Time Offset to setpublic Field13C setTimeOffset(java.util.Calendar component4)
component4
- Calendar with the Time Offset content to setsetComponent4(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field13C setOffset(java.lang.String component4)
component4
- the Time Offset to setsetTimeOffset(String)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field13C setOffset(java.util.Calendar component4)
component4
- Calendar with the Time Offset content to setsetComponent4(java.util.Calendar)
public java.lang.String getName()
public static Field13C get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field13C get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field13C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field13C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field13C fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)