
com.prowidesoftware.swift.model.field.Field92K Maven / Gradle / Ivy
The newest version!
/*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
*/
package com.prowidesoftware.swift.model.field;
import java.io.Serializable;
import org.apache.commons.lang.StringUtils;
import com.prowidesoftware.swift.model.field.PatternContainer;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.utils.SwiftFormatUtils;
/**
* Field 92K
*
* validation pattern: :4!c//4!c
* parser pattern: :S//S
* components pattern: SS
*
* Components Data types
*
* - component1:
String
* - component2:
String
*
*
* NOTE: this source code has been generated.
*
* @author www.prowidesoftware.com
*/
@SuppressWarnings("unused")
public class Field92K extends Field implements Serializable, PatternContainer, GenericField {
private static final long serialVersionUID = 1L;
public static final String NAME = "92K";
public static final String PARSER_PATTERN =":S//S";
public static final String COMPONENTS_PATTERN = "SS";
/**
* Default constructor
*/
public Field92K() {
super(2);
}
/**
* Creates the field parsing the parameter value into fields' components
* @param value
*/
public Field92K(String value) {
this();
setComponent1(SwiftParseUtils.getTokenFirst(value, ":", "//"));
setComponent2(SwiftParseUtils.getTokenSecondLast(value, "//"));
}
/**
* Serializes the fields' components into the single string value (SWIFT format)
*/
@Override
public String getValue() {
final StringBuilder result = new StringBuilder();
result.append(":");
result.append(StringUtils.trimToEmpty(getComponent1()));
result.append("//");
result.append(StringUtils.trimToEmpty(getComponent2()));
return result.toString();
}
/**
* Get the component1
* @return the component1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Get the Qualifier (component1).
* @return the Qualifier from component1
*/
public String getQualifier() {
return getComponent(1);
}
/**
* Set the component1.
* @param component1 the component1 to set
*/
public void setComponent1(String component1) {
setComponent(1, component1);
}
/**
* Set the Qualifier (component1).
* @param component1 the Qualifier to set
*/
public void setQualifier(String component1) {
setComponent(1, component1);
}
/**
* Get the component2
* @return the component2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Get the Rate Type Code (component2).
* @return the Rate Type Code from component2
*/
public String getRateTypeCode() {
return getComponent(2);
}
/**
* Set the component2.
* @param component2 the component2 to set
*/
public void setComponent2(String component2) {
setComponent(2, component2);
}
/**
* Set the Rate Type Code (component2).
* @param component2 the Rate Type Code to set
*/
public void setRateTypeCode(String component2) {
setComponent(2, component2);
}
/**
* 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.
*
* @param component component number, first component of a field is referenced as 1
* @return true if the component is optional for this field, false otherwise
*/
@Override
public boolean isOptional(int component) {
return false;
}
/**
* Returns true if the field is a GENERIC FIELD as specified by the standard.
*
* @return true if the field is generic, false otherwise
*/
@Override
public boolean isGeneric() {
return true;
}
/**
* 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.
*
* @return DSS component value or null
if the DSS is not set or not available for this field.
*/
public String getDSS() {
return null;
}
/**
* Checks if the issuer code (or Data Source Scheme or DSS) is present.
*
* @see #getDSS()
* @return true if DSS is present, false otherwise.
*/
public boolean isDSSPresent() {
return getDSS() != null;
}
/**
* Gets the conditional qualifier.
* The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
*
* @return for generic fields returns the value of the conditional qualifier or null
if not set or not applicable for this kind of field.
*/
public String getConditionalQualifier() {
return getComponent(2);
}
public String componentsPattern() {
return COMPONENTS_PATTERN;
}
public String parserPattern() {
return PARSER_PATTERN;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy