Class Field13C
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field13C
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field13C extends Field implements java.io.Serializable
SWIFT MT Field 13C.Model and parser for field 13C of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Code:
String
- Component 2: TimeIndication:
Calendar
- Component 3: Sign:
Character
- Component 4: TimeOffset:
Calendar
Structure definition
- validation pattern:
/8c/<HHMM><SIGN><OFFSET>
- parser pattern:
/S/<HHMM><SIGN><OFFSET>
- components pattern:
SHGO
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
CODE
Component number for the Code subfield.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.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.use #TIME_OFFSET insteadstatic java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.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.use #TIME_INDICATION insteadstatic 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
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field13C()
Default constructor.Field13C(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field13C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
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.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 Calendarjava.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 Calendarjava.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.protected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.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.use #getTimeOffset() insteadjava.util.Calendar
getOffsetAsCalendar()
Deprecated.use #getTimeOffsetAsCalendar() insteadjava.lang.String
getSign()
Gets the Sign (component 3).java.lang.String
getTime()
Deprecated.use #getTimeIndication() insteadjava.util.Calendar
getTimeAsCalendar()
Deprecated.use #getTimeIndicationAsCalendar() insteadjava.lang.String
getTimeIndication()
Gets the Time Indication (component 2).java.util.Calendar
getTimeIndicationAsCalendar()
Get the Time Indication (component 2) as Calendarjava.lang.String
getTimeOffset()
Gets the Time Offset (component 4).java.util.Calendar
getTimeOffsetAsCalendar()
Get the Time Offset (component 4) as Calendarjava.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.lang.String component2)
Set the component 2 (Time Indication).Field13C
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.Field13C
setComponent3(java.lang.String component3)
Set the component 3 (Sign).Field13C
setComponent4(java.lang.String component4)
Set the component 4 (Time Offset).Field13C
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.Field13C
setOffset(java.lang.String component4)
Deprecated.use #setTimeOffset(String) insteadField13C
setOffset(java.util.Calendar component4)
Deprecated.use #setComponent4(java.util.Calendar) insteadField13C
setSign(java.lang.String component3)
Set the Sign (component 3).Field13C
setTime(java.lang.String component2)
Deprecated.use #setTimeIndication(String) insteadField13C
setTime(java.util.Calendar component2)
Deprecated.use #setComponent2(java.util.Calendar) insteadField13C
setTimeIndication(java.lang.String component2)
Set the Time Indication (component 2).Field13C
setTimeIndication(java.util.Calendar component2)
Set the Time Indication (component 2) from a Calendar object.Field13C
setTimeOffset(java.lang.String component4)
Set the Time Offset (component 4).Field13C
setTimeOffset(java.util.Calendar component4)
Set the Time Offset (component 4) from a Calendar object.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-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 13C.- See Also:
- Constant Field Values
-
F_13C
public static final java.lang.String F_13C
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
CODE
public static final java.lang.Integer CODE
Component number for the Code subfield.
-
TIME_INDICATION
public static final java.lang.Integer TIME_INDICATION
Component number for the Time Indication subfield.
-
TIME
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer TIME
Deprecated.use #TIME_INDICATION instead
-
SIGN
public static final java.lang.Integer SIGN
Component number for the Sign subfield.
-
TIME_OFFSET
public static final java.lang.Integer TIME_OFFSET
Component number for the Time Offset subfield.
-
OFFSET
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer OFFSET
Deprecated.use #TIME_OFFSET instead
-
-
Constructor Detail
-
Field13C
public Field13C()
Default constructor. Creates a new field setting all components to null.
-
Field13C
public Field13C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field13C
public Field13C(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field13C newInstance(Field13C source)
Copy constructor. Initializes the components list with a deep copy of the source components list.- Parameters:
source
- a field instance to copy- Since:
- 7.7
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew Tag(NAME, value)
- Since:
- 7.5
- See Also:
NAME
-
emptyTag
public static Tag emptyTag()
Create a Tag with this field name and an empty string as value. Shorthand fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
isOptional
public 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.- Specified by:
isOptional
in classField
- Parameters:
component
- component number, first component of a field is referenced as 1- Returns:
- true if the component is optional for this field, false otherwise
-
isGeneric
public boolean isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
-
componentsSize
public 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.- Specified by:
componentsSize
in classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Code).- Returns:
- the component 1
-
getCode
public java.lang.String getCode()
Gets the Code (component 1).- Returns:
- the Code from component 1
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Time Indication).- Returns:
- the component 2
-
getComponent2AsCalendar
public java.util.Calendar getComponent2AsCalendar()
Get the component 2 as Calendar- Returns:
- the component 2 converted to Calendar or null if cannot be converted
-
getTimeIndication
public java.lang.String getTimeIndication()
Gets the Time Indication (component 2).- Returns:
- the Time Indication from component 2
-
getTime
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getTime()
Deprecated.use #getTimeIndication() insteadAlternative DEPRECATED method getter for field's Time Indication- Since:
- 9.2.7
-
getTimeIndicationAsCalendar
public java.util.Calendar getTimeIndicationAsCalendar()
Get the Time Indication (component 2) as Calendar- Returns:
- the Time Indication from component 2 converted to Calendar or null if cannot be converted
-
getTimeAsCalendar
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getTimeAsCalendar()
Deprecated.use #getTimeIndicationAsCalendar() instead
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Sign).- Returns:
- the component 3
-
getSign
public java.lang.String getSign()
Gets the Sign (component 3).- Returns:
- the Sign from component 3
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (Time Offset).- Returns:
- the component 4
-
getComponent4AsCalendar
public java.util.Calendar getComponent4AsCalendar()
Get the component 4 as Calendar- Returns:
- the component 4 converted to Calendar or null if cannot be converted
-
getTimeOffset
public java.lang.String getTimeOffset()
Gets the Time Offset (component 4).- Returns:
- the Time Offset from component 4
-
getOffset
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getOffset()
Deprecated.use #getTimeOffset() insteadAlternative DEPRECATED method getter for field's Time Offset- Since:
- 9.2.7
-
getTimeOffsetAsCalendar
public java.util.Calendar getTimeOffsetAsCalendar()
Get the Time Offset (component 4) as Calendar- Returns:
- the Time Offset from component 4 converted to Calendar or null if cannot be converted
-
getOffsetAsCalendar
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getOffsetAsCalendar()
Deprecated.use #getTimeOffsetAsCalendar() instead
-
setComponent1
public Field13C setComponent1(java.lang.String component1)
Set the component 1 (Code).- Parameters:
component1
- the Code to set- Returns:
- the field object to enable build pattern
-
setCode
public Field13C setCode(java.lang.String component1)
Set the Code (component 1).- Parameters:
component1
- the Code to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field13C setComponent2(java.lang.String component2)
Set the component 2 (Time Indication).- Parameters:
component2
- the Time Indication to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field13C setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.- Parameters:
component2
- the Calendar with the Time Indication content to set- Returns:
- the field object to enable build pattern
-
setTimeIndication
public Field13C setTimeIndication(java.lang.String component2)
Set the Time Indication (component 2).- Parameters:
component2
- the Time Indication to set- Returns:
- the field object to enable build pattern
-
setTimeIndication
public Field13C setTimeIndication(java.util.Calendar component2)
Set the Time Indication (component 2) from a Calendar object.- Parameters:
component2
- Calendar with the Time Indication content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(java.util.Calendar)
-
setTime
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field13C setTime(java.lang.String component2)
Deprecated.use #setTimeIndication(String) instead
-
setTime
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field13C setTime(java.util.Calendar component2)
Deprecated.use #setComponent2(java.util.Calendar) instead
-
setComponent3
public Field13C setComponent3(java.lang.String component3)
Set the component 3 (Sign).- Parameters:
component3
- the Sign to set- Returns:
- the field object to enable build pattern
-
setSign
public Field13C setSign(java.lang.String component3)
Set the Sign (component 3).- Parameters:
component3
- the Sign to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field13C setComponent4(java.lang.String component4)
Set the component 4 (Time Offset).- Parameters:
component4
- the Time Offset to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field13C setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.- Parameters:
component4
- the Calendar with the Time Offset content to set- Returns:
- the field object to enable build pattern
-
setTimeOffset
public Field13C setTimeOffset(java.lang.String component4)
Set the Time Offset (component 4).- Parameters:
component4
- the Time Offset to set- Returns:
- the field object to enable build pattern
-
setTimeOffset
public Field13C setTimeOffset(java.util.Calendar component4)
Set the Time Offset (component 4) from a Calendar object.- Parameters:
component4
- Calendar with the Time Offset content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent4(java.util.Calendar)
-
setOffset
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field13C setOffset(java.lang.String component4)
Deprecated.use #setTimeOffset(String) instead
-
setOffset
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field13C setOffset(java.util.Calendar component4)
Deprecated.use #setComponent4(java.util.Calendar) instead
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field13C get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.- Parameters:
block
- may be null or empty- Returns:
- null if not found o block is null or empty
-
get
public static Field13C get(SwiftMessage msg)
Gets the first instance of Field13C in the given message.- Parameters:
msg
- may be empty or null- Returns:
- null if not found or msg is empty or null
- See Also:
get(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
msg
- may be empty or null in which case an empty list is returned- See Also:
getAll(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
block
- may be empty or null in which case an empty list is returned
-
fromJson
public static Field13C fromJson(java.lang.String json)
This method deserializes the JSON data into a Field13C object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
-