Class Field95P
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.OptionPPartyField
-
- com.prowidesoftware.swift.model.field.Field95P
-
- All Implemented Interfaces:
JsonSerializable
,BICContainer
,GenericField
,PatternContainer
,java.io.Serializable
@Generated public class Field95P extends OptionPPartyField implements java.io.Serializable, BICContainer, GenericField
SWIFT MT Field 95P.Model and parser for field 95P of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Qualifier:
String
- Component 2: IdentifierCode:
BIC
Structure definition
- validation pattern:
:4!c//<BIC>
- parser pattern:
:S//S
- components pattern:
SB
This class complies with standard release SRU2023
- 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_95P
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 95P.static int
SRU
Constant identifying the SRU to which this class belongs to.-
Fields inherited from class com.prowidesoftware.swift.model.field.OptionPPartyField
BIC, COMPONENTS_PATTERN, IDENTIFIER_CODE, PARSER_PATTERN, QUALIFIER, TYPES_PATTERN
-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field95P()
Default constructor.Field95P(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field95P(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 Deprecated Methods Modifier and Type Method Description java.util.List<BIC>
bics()
Utility method that creates a BIC for every string returned byBICContainer.bicStrings()
java.util.List<java.lang.String>
bicStrings()
Get a list of strings of BICs present in this fieldstatic Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field95P
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field95P object.static Field95P
get(SwiftMessage msg)
Gets the first instance of Field95P in the given message.static Field95P
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field95P>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field95P in the given message an empty list is returned if none found.static java.util.List<Field95P>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field95P 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
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 Field95P
newInstance(Field95P source)
Copy constructor.Field95P
setBIC(BIC component2)
Deprecated.use #setComponent2(com.prowidesoftware.swift.model.BIC) insteadField95P
setBIC(java.lang.String component2)
Deprecated.use #setIdentifierCode(String) insteadField95P
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).Field95P
setComponent2(BIC component2)
Set the component2 from a BIC object.Field95P
setComponent2(java.lang.String component2)
Set the component 2 (IdentifierCode).Field95P
setIdentifierCode(BIC component2)
Set the IdentifierCode (component 2) from a BIC object.Field95P
setIdentifierCode(java.lang.String component2)
Set the IdentifierCode (component 2).Field95P
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.OptionPPartyField
componentsPattern, componentsSize, getBIC, getBICAsBIC, getComponent1, getComponent2, getComponent2AsBIC, getComponentLabels, getComponentMap, getIdentifierCode, getIdentifierCodeAsBIC, getLabelMap, 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
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.prowidesoftware.swift.model.field.PatternContainer
parserPattern, typesPattern
-
-
-
-
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 95P.- See Also:
- Constant Field Values
-
F_95P
public static final java.lang.String F_95P
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
-
Field95P
public Field95P()
Default constructor. Creates a new field setting all components to null.
-
Field95P
public Field95P(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
-
Field95P
public Field95P(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withOptionPPartyField.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 Field95P newInstance(Field95P 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 classOptionPPartyField
-
setComponent1
public Field95P 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 Field95P 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 Field95P setComponent2(java.lang.String component2)
Set the component 2 (IdentifierCode).- Parameters:
component2
- the IdentifierCode to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field95P setComponent2(BIC component2)
Set the component2 from a BIC object.- Parameters:
component2
- the BIC with the IdentifierCode content to set- Returns:
- the field object to enable build pattern
-
setIdentifierCode
public Field95P setIdentifierCode(java.lang.String component2)
Set the IdentifierCode (component 2).- Parameters:
component2
- the IdentifierCode to set- Returns:
- the field object to enable build pattern
-
setIdentifierCode
public Field95P setIdentifierCode(BIC component2)
Set the IdentifierCode (component 2) from a BIC object.- Parameters:
component2
- BIC with the IdentifierCode content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(com.prowidesoftware.swift.model.BIC)
-
setBIC
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field95P setBIC(java.lang.String component2)
Deprecated.use #setIdentifierCode(String) instead
-
setBIC
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field95P setBIC(BIC component2)
Deprecated.use #setComponent2(com.prowidesoftware.swift.model.BIC) instead
-
bics
public java.util.List<BIC> bics()
Description copied from interface:BICContainer
Utility method that creates a BIC for every string returned byBICContainer.bicStrings()
- Specified by:
bics
in interfaceBICContainer
- Overrides:
bics
in classOptionPPartyField
- Returns:
- list of BIC objects
-
bicStrings
public java.util.List<java.lang.String> bicStrings()
Description copied from interface:BICContainer
Get a list of strings of BICs present in this field- Specified by:
bicStrings
in interfaceBICContainer
- Overrides:
bicStrings
in classOptionPPartyField
- Returns:
- a list, with zero or more BICs in this field.
-
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 classOptionPPartyField
- Returns:
- the static value of Field95P.NAME
-
get
public static Field95P 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 Field95P get(SwiftMessage msg)
Gets the first instance of Field95P 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<Field95P> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field95P 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<Field95P> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field95P 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
-
fromJson
public static Field95P fromJson(java.lang.String json)
This method deserializes the JSON data into a Field95P 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)
-
-