com.prowidesoftware.swift.model.field.Field38E Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wife Show documentation
Prowide Core Libraries for SWIFT (TM) messages
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 38E


 *
 * validation pattern: 2n1a

 * parser pattern: NS

 * components pattern: NS

 *
 * Components Data types
 *  
 * 		component1: Number 
 * 		component2: String 
 * 
 *		 
 * NOTE: this source code has been generated.
 *
 * @author www.prowidesoftware.com
 */
@SuppressWarnings("unused") 
public class Field38E extends Field implements Serializable, PatternContainer {
	private static final long serialVersionUID = 1L;
    public static final String NAME = "38E";
	public static final String PARSER_PATTERN ="NS";
	public static final String COMPONENTS_PATTERN = "NS";

	/**
	 * Default constructor
	 */
	public Field38E() {
		super(2);
	}
	    					
	/**
	 * Creates the field parsing the parameter value into fields' components
	 * @param value
	 */
	public Field38E(String value) {
		this();

		setComponent1(SwiftParseUtils.getNumericPrefix(value));
		setComponent2(SwiftParseUtils.getAlphaSuffix(value));
	}
	
	/**
	 * Serializes the fields' components into the single string value (SWIFT format)
	 */
	@Override
	public String getValue() {
		final StringBuilder result = new StringBuilder();
		result.append(joinComponents());
		return result.toString();
	}


	/**
	 * Get the component1
	 * @return the component1
	 */
	public String getComponent1() {
		return getComponent(1);
	}

	/**
	 * Get the component1 as Number
	 * @return the component1 converted to Number or null if cannot be converted
	 */
	public java.lang.Number getComponent1AsNumber() {
		return SwiftFormatUtils.getNumber(getComponent(1));
	}

	/**
	 * Get the Number (component1).
	 * @return the Number from component1
	 */
	public String getNumber() {
		return getComponent(1);
	}
	
	/**
	 * Get the Number (component1) as Number
	 * @return the Number from component1 converted to Number or null if cannot be converted
	 */
	public java.lang.Number getNumberAsNumber() {
		return SwiftFormatUtils.getNumber(getComponent(1));
	}

	/**
	 * Set the component1.
	 * @param component1 the component1 to set
	 */
	public void setComponent1(String component1) {
		setComponent(1, component1);
	}
	
	/**
	 * Set the component1.
	 * @param Number with the component1 content to set
	 */
	public void setComponent1(java.lang.Number component1) {
		setComponent(1, SwiftFormatUtils.getNumber(component1));
	}
	
	/**
	 * Set the Number (component1).
	 * @param component1 the Number to set
	 */
	public void setNumber(String component1) {
		setComponent(1, component1);
	}
	
	/**
	 * Set the Number (component1) as Number
	 * @param Number with the Number content to set
	 */
	public void setNumber(java.lang.Number component1) {
		setComponent(1, SwiftFormatUtils.getNumber(component1));
	}

	/**
	 * Get the component2
	 * @return the component2
	 */
	public String getComponent2() {
		return getComponent(2);
	}

	/**
	 * Set the component2.
	 * @param component2 the component2 to set
	 */
	public void setComponent2(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 false;
   }
   
   public String componentsPattern() {
           return COMPONENTS_PATTERN;
   }

   public String parserPattern() {
           return PARSER_PATTERN;
   }


}