@Generated public class Field118 extends Field implements Serializable
Boolean
<BOOL>
S
L
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static String |
F_118
same as NAME, intended to be clear when using static imports
|
static Integer |
LT_SUBSETS_SHARED_FLAG
Component number for the LT Subsets Shared Flag subfield
|
static String |
NAME
Constant with the field name 118
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field118()
Default constructor.
|
Field118(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field118(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
String |
componentsPattern()
Returns the field's 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 Field118 |
get(SwiftMessage msg)
Get the first instance of Field118 in the given message.
|
static Field118 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field118> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field118 in the given message
an empty list is returned if none found.
|
static List<Field118> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field118 from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
Boolean |
getComponent1AsBoolean()
Get the component1 as Boolean
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getLTSubsetsSharedFlag()
Get the LT Subsets Shared Flag (component1).
|
Boolean |
getLTSubsetsSharedFlagAsBoolean()
Get the LT Subsets Shared Flag (component1) as Boolean
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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 Field118 |
newInstance(Field118 source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field118 |
setComponent1(Boolean component1)
Set the component1 from a Boolean object.
|
Field118 |
setComponent1(String component1)
Set the component1.
|
Field118 |
setLTSubsetsSharedFlag(Boolean component1)
Set the LT Subsets Shared Flag (component1) from a Boolean object.
|
Field118 |
setLTSubsetsSharedFlag(String component1)
Set the LT Subsets Shared Flag (component1).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_118
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer LT_SUBSETS_SHARED_FLAG
public Field118()
public Field118(String value)
value
- complete field value including separators and CRLFpublic Field118(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field118 newInstance(Field118 source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
public Boolean getComponent1AsBoolean()
null
if cannot be convertedpublic String getLTSubsetsSharedFlag()
public Boolean getLTSubsetsSharedFlagAsBoolean()
null
if cannot be convertedpublic Field118 setComponent1(String component1)
component1
- the component1 to setpublic Field118 setComponent1(Boolean component1)
component1
- the Boolean with the component1 content to setpublic Field118 setLTSubsetsSharedFlag(String component1)
component1
- the LT Subsets Shared Flag to setpublic Field118 setLTSubsetsSharedFlag(Boolean component1)
component1
- Boolean with the LT Subsets Shared Flag content to setsetComponent1(java.lang.Boolean)
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
public static Field118 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field118 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field118> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field118> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)