com.prowidesoftware.swift.model.SwiftValueBlock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wife
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.
*/
/*
 * Created on Sep 23, 2005 
 */
package com.prowidesoftware.swift.model;

import java.io.Serializable;

/**
 * Base class for SWIFT blocks that contain its fields concatenated as a single fixed length value; blocks 1 and 2.

 * This is an abstract class so specific block classes for each block should be instantiated.
 *
 * @author www.prowidesoftware.com
 * @since 4.0
 * @version $Id: SwiftValueBlock.java,v 1.2 2010/10/17 01:22:01 zubri Exp $
 */
public abstract class SwiftValueBlock extends SwiftBlock implements Serializable {
	//private static transient final java.util.logging.Logger log = java.util.logging.Logger.getLogger(SwiftValueBlock.class);

	private static final long serialVersionUID = 1L;

	/**
	 * Default constructor, shouldn't be used normally.
	 * present only for subclasses
	 */
	protected SwiftValueBlock() {

	}

	/**
	 * This method should be overwritten by subclasses, calling 
	 * this method will throw a java.lang.UnsupportedOperationException
	 * @return N/A
	 */
	public String getBlockValue() {
		throw new UnsupportedOperationException("cannot call getBlockValue on SwiftValueBlock, must be on specific subclasses");
	}

	/**
	 * This method should be overwritten by subclasses, calling 
	 * this method will throw a java.lang.UnsupportedOperationException
	 * 
	 * @return the blocks value as a single string
	 */
	public String getValue() {
		throw new UnsupportedOperationException("cannot call getValue on SwiftValueBlock, must be on specific subclasses");
	}

	/**
	 * This method should be overwritten by subclasses and proper 
	 * parsing be done to set specific values of the block, calling 
	 * this method will throw a java.lang.UnsupportedOperationException
	 * 
	 * @param value the blocks value as a single string
	 */
	public void setValue(final String value) {
		throw new UnsupportedOperationException("cannot call setValue on SwiftValueBlock, must be on specific subclasses");
	}

	/**
	 * This method should be overwritten by subclasses, calling 
	 * this method will throw a java.lang.UnsupportedOperationException
	 * @param value unused 
	 */
	public void setBlockValue(final String value) {
		throw new UnsupportedOperationException("cannot call setBlockValue on SwiftValueBlock, must be on specific subclasses");
	}

	/**
	 * Tells if the block contains at least one field.
	 * This method must be called on specific subclasses, calling it for SwiftValueBlock will throw 
	 * a java.lang.UnsupportedOperationException
	 * @return true if getValue returns a non null object
	 */
	public boolean isEmpty() {
		return (this.getValue() == null);
	}

	/**
	 * Tells the block's string value size (in chars).

	 * NOTICE this does not return the actual number of fields set
	 * because value blocks are mostly fixed length.
	 * This method must be called on specific subclasses, calling it for SwiftValueBlock will throw 
	 * a java.lang.UnsupportedOperationException
	 * @return the size of the value or zero if value is null 
	 */
	public int size() {
		return (this.getValue() == null ? 0 : this.getValue().length());
	}

	/**
	 * returns a fragment of the block value received (or null if value is not large enough).

	 * This method is used in derived classes to get value fragments. 
	 * @param value the full block value
	 * @param start the starting point of the fragment in the big block value
	 * @param size the fragment size
	 * @return the value fragment or null if value is not large enough
	 */
	protected String getValuePart(final String value, final int start, int size) {

		// prepare the result
		String s = null;

		// check start is within bounds
		if (start < value.length()) {

			// check start+size is within bounds
			if ((start + size) >= value.length()) {
				size = value.length() - start;
			}

			// get the fragment
			try {
				s = value.substring(start, start + size);
			} catch (final IndexOutOfBoundsException ob) {
			}
			;
		}
		;

		return (s);
	}
}