@Generated public class Field172 extends Field implements Serializable, DateContainer
Calendar
Calendar
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
END_DATE
Component number for the End Date subfield
|
static String |
F_172
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 172
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
START_DATE
Component number for the Start Date subfield
|
components
Constructor and Description |
---|
Field172()
Default constructor.
|
Field172(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field172(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. |
List<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 Field172 |
get(SwiftMessage msg)
Get the first instance of Field172 in the given message.
|
static Field172 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field172> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field172 in the given message
an empty list is returned if none found.
|
static List<Field172> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field172 from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
Calendar |
getComponent1AsCalendar()
Get the component1 as Calendar
|
String |
getComponent2()
Get the component2
|
Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getEndDate()
Get the End Date (component2).
|
Calendar |
getEndDateAsCalendar()
Get the End Date (component2) as Calendar
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getStartDate()
Get the Start Date (component1).
|
Calendar |
getStartDateAsCalendar()
Get the Start Date (component1) as Calendar
|
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 Field172 |
newInstance(Field172 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() |
Field172 |
setComponent1(Calendar component1)
Set the component1 from a Calendar object.
|
Field172 |
setComponent1(String component1)
Set the component1.
|
Field172 |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field172 |
setComponent2(String component2)
Set the component2.
|
Field172 |
setEndDate(Calendar component2)
Set the End Date (component2) from a Calendar object.
|
Field172 |
setEndDate(String component2)
Set the End Date (component2).
|
Field172 |
setStartDate(Calendar component1)
Set the Start Date (component1) from a Calendar object.
|
Field172 |
setStartDate(String component1)
Set the Start Date (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
|
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, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_172
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer START_DATE
public static final Integer END_DATE
public Field172()
public Field172(String value)
value
- complete field value including separators and CRLFpublic Field172(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 Field172 newInstance(Field172 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 Calendar getComponent1AsCalendar()
null
if cannot be convertedpublic String getStartDate()
public Calendar getStartDateAsCalendar()
null
if cannot be convertedpublic Field172 setComponent1(String component1)
component1
- the component1 to setpublic Field172 setComponent1(Calendar component1)
component1
- the Calendar with the component1 content to setpublic Field172 setStartDate(String component1)
component1
- the Start Date to setpublic Field172 setStartDate(Calendar component1)
component1
- Calendar with the Start Date content to setsetComponent1(java.util.Calendar)
public String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getEndDate()
public Calendar getEndDateAsCalendar()
null
if cannot be convertedpublic Field172 setComponent2(String component2)
component2
- the component2 to setpublic Field172 setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field172 setEndDate(String component2)
component2
- the End Date to setpublic Field172 setEndDate(Calendar component2)
component2
- Calendar with the End Date content to setsetComponent2(java.util.Calendar)
public List<Calendar> dates()
DateContainer
dates
in interface DateContainer
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 Field172 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field172 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field172> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field172> 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)