@Generated public class Field77H extends Field implements java.io.Serializable, DateContainer, MultiLineField
Model and parser for field 77H of a SWIFT MT message.
Subfields (components) Data types
String
Calendar
Calendar
Structure definition
6a[/<DATE4>][//<YEAR>]
S[/S][//S]
SDY
This class complies with standard release SRU2019
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DATE
Component number for the Date subfield
|
static java.lang.String |
F_77H
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 77H
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
TYPE_OF_AGREEMENT
Component number for the Type Of Agreement subfield
|
static java.lang.Integer |
VERSION
Component number for the Version subfield
|
Constructor and Description |
---|
Field77H()
Default constructor.
|
Field77H(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field77H(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. |
java.util.List<java.util.Calendar> |
dates()
Get a calendar for every date found
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field77H |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field77H object.
|
static Field77H |
get(SwiftMessage msg)
Gets the first instance of Field77H in the given message.
|
static Field77H |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field77H> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field77H in the given message
an empty list is returned if none found.
|
static java.util.List<Field77H> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field77H from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component1 (Type Of Agreement).
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2 (Date).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component3 (Version).
|
java.util.Calendar |
getComponent3AsCalendar()
Get the component3 as Calendar
|
java.lang.String |
getDate()
Gets the Date (component2).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
java.lang.String |
getLine(int line)
Returns a specific line from the field's value.
|
java.lang.String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
java.util.List<java.lang.String> |
getLines()
Returns the field value split into lines.
|
java.util.List<java.lang.String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getTypeOfAgreement()
Gets the Type Of Agreement (component1).
|
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.
|
java.lang.String |
getVersion()
Gets the Version (component3).
|
java.util.Calendar |
getVersionAsCalendar()
Get the Version (component3) as Calendar
|
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 Field77H |
newInstance(Field77H 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
|
Field77H |
setComponent1(java.lang.String component1)
Set the component1 (Type Of Agreement).
|
Field77H |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field77H |
setComponent2(java.lang.String component2)
Set the component2 (Date).
|
Field77H |
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.
|
Field77H |
setComponent3(java.lang.String component3)
Set the component3 (Version).
|
Field77H |
setDate(java.util.Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field77H |
setDate(java.lang.String component2)
Set the Date (component2).
|
Field77H |
setTypeOfAgreement(java.lang.String component1)
Set the Type Of Agreement (component1).
|
Field77H |
setVersion(java.util.Calendar component3)
Set the Version (component3) from a Calendar object.
|
Field77H |
setVersion(java.lang.String component3)
Set the Version (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_77H
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer TYPE_OF_AGREEMENT
public static final java.lang.Integer DATE
public static final java.lang.Integer VERSION
public Field77H()
public Field77H(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field77H(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field77H newInstance(Field77H 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 getTypeOfAgreement()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public java.lang.String getComponent3()
public java.util.Calendar getComponent3AsCalendar()
public java.lang.String getVersion()
public java.util.Calendar getVersionAsCalendar()
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public Field77H setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field77H setTypeOfAgreement(java.lang.String component1)
component1
- the Type Of Agreement to setpublic Field77H setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field77H setComponent2(java.util.Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field77H setDate(java.lang.String component2)
component2
- the Date to setpublic Field77H setDate(java.util.Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public Field77H setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field77H setComponent3(java.util.Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field77H setVersion(java.lang.String component3)
component3
- the Version to setpublic Field77H setVersion(java.util.Calendar component3)
component3
- Calendar with the Version content to setsetComponent3(java.util.Calendar)
public java.lang.String getName()
public static Field77H get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field77H get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field77H> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field77H> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getLine(int line)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1MultiLineField.getLine(int)
public java.lang.String getLine(int line, int offset)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting linesMultiLineField.getLine(int, int)
public java.util.List<java.lang.String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public java.util.List<java.lang.String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public java.util.List<java.lang.String> getLinesBetween(int start, int end)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startMultiLineField.getLinesBetween(int, int )
public java.util.List<java.lang.String> getLinesBetween(int start, int end, int offset)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startoffset
- an optional component number used as offset when counting linesMultiLineField.getLinesBetween(int start, int end, int offset)
public static Field77H fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)