@Generated public class Field256 extends Field implements Serializable, DateContainer, BICContainer
BIC
Number
Number
Calendar
Calendar
Calendar
Modifier and Type | Field and Description |
---|---|
static Integer |
BIC
Component number for the BIC subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
DATE
Component number for the Date subfield
|
static Integer |
END_TIME
Component number for the End Time subfield
|
static String |
F_256
same as NAME, intended to be clear when using static imports
|
static Integer |
MESSAGE_CATEGORY
Component number for the Message Category subfield
|
static String |
NAME
Constant with the field name 256
|
static String |
PARSER_PATTERN |
static Integer |
SESSION_NUMBER
Component number for the Session Number subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
START_TIME
Component number for the Start Time subfield
|
components
Constructor and Description |
---|
Field256()
Default constructor.
|
Field256(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field256(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
List<BIC> |
bics()
Utility method that creates a BIC for every string returned by
BICContainer.bicStrings() |
List<String> |
bicStrings()
Get a list of strings of BICs present in this field
|
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 Field256 |
get(SwiftMessage msg)
Get the first instance of Field256 in the given message.
|
static Field256 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field256> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field256 in the given message
an empty list is returned if none found.
|
static List<Field256> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field256 from the given block
an empty list is returned if none found.
|
String |
getBIC()
Get the BIC (component1).
|
BIC |
getBICAsBIC()
Get the BIC (component1) as BIC
|
String |
getComponent1()
Get the component1
|
BIC |
getComponent1AsBIC()
Get the component1 as BIC
|
String |
getComponent2()
Get the component2
|
Number |
getComponent2AsNumber()
Get the component2 as Number
|
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
String |
getComponent4()
Get the component4
|
Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
String |
getComponent5()
Get the component5
|
Calendar |
getComponent5AsCalendar()
Get the component5 as Calendar
|
String |
getComponent6()
Get the component6
|
Calendar |
getComponent6AsCalendar()
Get the component6 as Calendar
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getDate()
Get the Date (component4).
|
Calendar |
getDateAsCalendar()
Get the Date (component4) as Calendar
|
String |
getEndTime()
Get the End Time (component6).
|
Calendar |
getEndTimeAsCalendar()
Get the End Time (component6) as Calendar
|
String |
getMessageCategory()
Get the Message Category (component3).
|
Number |
getMessageCategoryAsNumber()
Get the Message Category (component3) as Number
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getSessionNumber()
Get the Session Number (component2).
|
Number |
getSessionNumberAsNumber()
Get the Session Number (component2) as Number
|
String |
getStartTime()
Get the Start Time (component5).
|
Calendar |
getStartTimeAsCalendar()
Get the Start Time (component5) 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 Field256 |
newInstance(Field256 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() |
Field256 |
setBIC(BIC component1)
Set the BIC (component1) from a BIC object.
|
Field256 |
setBIC(String component1)
Set the BIC (component1).
|
Field256 |
setComponent1(BIC component1)
Set the component1 from a BIC object.
|
Field256 |
setComponent1(String component1)
Set the component1.
|
Field256 |
setComponent2(Number component2)
Set the component2 from a Number object.
|
Field256 |
setComponent2(String component2)
Set the component2.
|
Field256 |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field256 |
setComponent3(String component3)
Set the component3.
|
Field256 |
setComponent4(Calendar component4)
Set the component4 from a Calendar object.
|
Field256 |
setComponent4(String component4)
Set the component4.
|
Field256 |
setComponent5(Calendar component5)
Set the component5 from a Calendar object.
|
Field256 |
setComponent5(String component5)
Set the component5.
|
Field256 |
setComponent6(Calendar component6)
Set the component6 from a Calendar object.
|
Field256 |
setComponent6(String component6)
Set the component6.
|
Field256 |
setDate(Calendar component4)
Set the Date (component4) from a Calendar object.
|
Field256 |
setDate(String component4)
Set the Date (component4).
|
Field256 |
setEndTime(Calendar component6)
Set the End Time (component6) from a Calendar object.
|
Field256 |
setEndTime(String component6)
Set the End Time (component6).
|
Field256 |
setMessageCategory(Number component3)
Set the Message Category (component3) from a Number object.
|
Field256 |
setMessageCategory(String component3)
Set the Message Category (component3).
|
Field256 |
setSessionNumber(Number component2)
Set the Session Number (component2) from a Number object.
|
Field256 |
setSessionNumber(String component2)
Set the Session Number (component2).
|
Field256 |
setStartTime(Calendar component5)
Set the Start Time (component5) from a Calendar object.
|
Field256 |
setStartTime(String component5)
Set the Start Time (component5).
|
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_256
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer BIC
public static final Integer SESSION_NUMBER
public static final Integer MESSAGE_CATEGORY
public static final Integer DATE
public static final Integer START_TIME
public static final Integer END_TIME
public Field256()
public Field256(String value)
value
- complete field value including separators and CRLFpublic Field256(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 Field256 newInstance(Field256 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 BIC getComponent1AsBIC()
null
if cannot be convertedpublic String getBIC()
public BIC getBICAsBIC()
null
if cannot be convertedpublic Field256 setComponent1(String component1)
component1
- the component1 to setpublic Field256 setComponent1(BIC component1)
component1
- the BIC with the component1 content to setpublic Field256 setBIC(String component1)
component1
- the BIC to setpublic Field256 setBIC(BIC component1)
component1
- BIC with the BIC content to setsetComponent1(com.prowidesoftware.swift.model.BIC)
public String getComponent2()
public Number getComponent2AsNumber()
null
if cannot be convertedpublic String getSessionNumber()
public Number getSessionNumberAsNumber()
null
if cannot be convertedpublic Field256 setComponent2(String component2)
component2
- the component2 to setpublic Field256 setComponent2(Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field256 setSessionNumber(String component2)
component2
- the Session Number to setpublic Field256 setSessionNumber(Number component2)
component2
- Number with the Session Number content to setsetComponent2(java.lang.Number)
public String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getMessageCategory()
public Number getMessageCategoryAsNumber()
null
if cannot be convertedpublic Field256 setComponent3(String component3)
component3
- the component3 to setpublic Field256 setComponent3(Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field256 setMessageCategory(String component3)
component3
- the Message Category to setpublic Field256 setMessageCategory(Number component3)
component3
- Number with the Message Category content to setsetComponent3(java.lang.Number)
public String getComponent4()
public Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field256 setComponent4(String component4)
component4
- the component4 to setpublic Field256 setComponent4(Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field256 setDate(String component4)
component4
- the Date to setpublic Field256 setDate(Calendar component4)
component4
- Calendar with the Date content to setsetComponent4(java.util.Calendar)
public String getComponent5()
public Calendar getComponent5AsCalendar()
null
if cannot be convertedpublic String getStartTime()
public Calendar getStartTimeAsCalendar()
null
if cannot be convertedpublic Field256 setComponent5(String component5)
component5
- the component5 to setpublic Field256 setComponent5(Calendar component5)
component5
- the Calendar with the component5 content to setpublic Field256 setStartTime(String component5)
component5
- the Start Time to setpublic Field256 setStartTime(Calendar component5)
component5
- Calendar with the Start Time content to setsetComponent5(java.util.Calendar)
public String getComponent6()
public Calendar getComponent6AsCalendar()
null
if cannot be convertedpublic String getEndTime()
public Calendar getEndTimeAsCalendar()
null
if cannot be convertedpublic Field256 setComponent6(String component6)
component6
- the component6 to setpublic Field256 setComponent6(Calendar component6)
component6
- the Calendar with the component6 content to setpublic Field256 setEndTime(String component6)
component6
- the End Time to setpublic Field256 setEndTime(Calendar component6)
component6
- Calendar with the End Time content to setsetComponent6(java.util.Calendar)
public List<Calendar> dates()
DateContainer
dates
in interface DateContainer
public List<BIC> bics()
BICContainer
BICContainer.bicStrings()
bics
in interface BICContainer
public List<String> bicStrings()
BICContainer
bicStrings
in interface BICContainer
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 Field256 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field256 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field256> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field256> 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)