Class Field95U
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.OptionUPartyField
-
- com.prowidesoftware.swift.model.field.Field95U
-
- All Implemented Interfaces:
JsonSerializable
,GenericField
,MultiLineField
,PatternContainer
,java.io.Serializable
@Generated public class Field95U extends OptionUPartyField implements java.io.Serializable, GenericField, MultiLineField
SWIFT MT Field 95U.Model and parser for field 95U of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Qualifier:
String
- Component 2: PartyName:
String
- Component 3: PartyName2:
String
- Component 4: PartyName3:
String
Structure definition
- validation pattern:
:4!c//35x[$35x]0-2(***)
- parser pattern:
:S//S[$S]0-2
- components pattern:
SSSS
This class complies with standard release SRU2022
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.static java.lang.String
F_95U
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 95U.static int
SRU
Constant identifying the SRU to which this class belongs to.-
Fields inherited from class com.prowidesoftware.swift.model.field.OptionUPartyField
COMPONENTS_PATTERN, PARSER_PATTERN, PARTY_NAME, QUALIFIER, TYPES_PATTERN
-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field95U()
Default constructor.Field95U(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field95U(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 Modifier and Type Method Description static Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field95U
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field95U object.static Field95U
get(SwiftMessage msg)
Gets the first instance of Field95U in the given message.static Field95U
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field95U>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field95U in the given message an empty list is returned if none found.static java.util.List<Field95U>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field95U from the given block an empty list is returned if none found.java.lang.String
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.java.lang.String
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).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).boolean
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.static Field95U
newInstance(Field95U source)
Copy constructor.Field95U
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).Field95U
setComponent2(java.lang.String component2)
Set the component 2 (Party Name).Field95U
setComponent3(java.lang.String component3)
Set the component 3 (Party Name 2).Field95U
setComponent4(java.lang.String component4)
Set the component 4 (Party Name 3).Field95U
setPartyName(java.lang.String value)
Set the Party Name splitting the parameter lines into components 2 to 4.Field95U
setPartyNameLine1(java.lang.String component2)
Set the Party Name (component 2).Field95U
setPartyNameLine2(java.lang.String component3)
Set the Party Name 2 (component 3).Field95U
setPartyNameLine3(java.lang.String component4)
Set the Party Name 3 (component 4).Field95U
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).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.-
Methods inherited from class com.prowidesoftware.swift.model.field.OptionUPartyField
componentsPattern, componentsSize, getComponent1, getComponent2, getComponent3, getComponent4, getComponentLabels, getComponentMap, getLabelMap, getPartyName, getPartyNameLine1, getPartyNameLine2, getPartyNameLine3, getQualifier, getValue, getValueDisplay, isGeneric, isOptional, parse, parserPattern, typesPattern
-
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 95U.- See Also:
- Constant Field Values
-
F_95U
public static final java.lang.String F_95U
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
CONDITIONAL_QUALIFIER
public static final java.lang.Integer CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.
-
-
Constructor Detail
-
Field95U
public Field95U()
Default constructor. Creates a new field setting all components to null.
-
Field95U
public Field95U(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
-
Field95U
public Field95U(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withOptionUPartyField.parse(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 Field95U newInstance(Field95U 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
-
validatorPattern
public final java.lang.String validatorPattern()
Returns the field validator pattern.- Specified by:
validatorPattern
in classOptionUPartyField
-
setComponent1
public Field95U setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).- Parameters:
component1
- the Qualifier to set- Returns:
- the field object to enable build pattern
-
setQualifier
public Field95U setQualifier(java.lang.String component1)
Set the Qualifier (component 1).- Parameters:
component1
- the Qualifier to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field95U setComponent2(java.lang.String component2)
Set the component 2 (Party Name).- Parameters:
component2
- the Party Name to set- Returns:
- the field object to enable build pattern
-
setPartyNameLine1
public Field95U setPartyNameLine1(java.lang.String component2)
Set the Party Name (component 2).- Parameters:
component2
- the Party Name to set- Returns:
- the field object to enable build pattern
-
setPartyName
public Field95U setPartyName(java.lang.String value)
Set the Party Name splitting the parameter lines into components 2 to 4.- Parameters:
value
- the Party Name to set, may contain line ends and each line will be set to its correspondent component attribute- Returns:
- the field object to enable build pattern
-
setComponent3
public Field95U setComponent3(java.lang.String component3)
Set the component 3 (Party Name 2).- Parameters:
component3
- the Party Name 2 to set- Returns:
- the field object to enable build pattern
-
setPartyNameLine2
public Field95U setPartyNameLine2(java.lang.String component3)
Set the Party Name 2 (component 3).- Parameters:
component3
- the Party Name 2 to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field95U setComponent4(java.lang.String component4)
Set the component 4 (Party Name 3).- Parameters:
component4
- the Party Name 3 to set- Returns:
- the field object to enable build pattern
-
setPartyNameLine3
public Field95U setPartyNameLine3(java.lang.String component4)
Set the Party Name 3 (component 4).- Parameters:
component4
- the Party Name 3 to set- Returns:
- the field object to enable build pattern
-
getDSS
public java.lang.String getDSS()
Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.- Specified by:
getDSS
in interfaceGenericField
- Returns:
- DSS component value or null if the DSS is not set or not available for this field.
-
isDSSPresent
public boolean isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.- Specified by:
isDSSPresent
in interfaceGenericField
- Returns:
- true if DSS is present, false otherwise.
- See Also:
getDSS()
-
getConditionalQualifier
public java.lang.String getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.- Specified by:
getConditionalQualifier
in interfaceGenericField
- Returns:
- for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this field.
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).- Specified by:
getName
in classOptionUPartyField
- Returns:
- the static value of Field95U.NAME
-
get
public static Field95U 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 Field95U get(SwiftMessage msg)
Gets the first instance of Field95U 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<Field95U> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field95U 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<Field95U> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field95U 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
-
getLine
public java.lang.String getLine(int line)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int)
-
getLine
public java.lang.String getLine(int line, int offset)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting lines- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int, int)
-
getLines
public java.util.List<java.lang.String> getLines()
Returns the field value split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Returns:
- lines content or empty list if field's value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLines()
-
getLines
public java.util.List<java.lang.String> getLines(int offset)
Returns the field value starting at the offset component, split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Parameters:
offset
- an optional component number used as offset when counting lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLines(int)
-
getLinesBetween
public 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.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
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 start- Returns:
- found lines or empty list if value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int, int )
-
getLinesBetween
public 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.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
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 lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int start, int end, int offset)
-
fromJson
public static Field95U fromJson(java.lang.String json)
This method deserializes the JSON data into a Field95U 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)
-
-