com.prowidesoftware.swift.model.SwiftBlock4.java Source code

Introduction

Here is the source code for com.prowidesoftware.swift.model.SwiftBlock4.java

Source

/*******************************************************************************
 * Copyright (c) 2016 Prowide Inc.
 *
 *     This program 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 3 of the 
 *     License, or (at your option) any later version.
 *
 *     This program 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.  
 *     
 *     Check the LGPL at <http://www.gnu.org/licenses/> for more details.
 *******************************************************************************/
package com.prowidesoftware.swift.model;

import java.io.Serializable;
import java.util.List;

import org.apache.commons.lang.Validate;

/**
 * Base class for SWIFT <b>Body Block (block 4)</b>.<br>
 * This block is where the actual message content is specified 
 * and is what most users see. Generally the other blocks are 
 * stripped off before presentation. It mainly contains a list of
 * tags and its format representation, which is variable 
 * length and requires use of CRLF as a field delimiter.<br>
 * 
 * @author www.prowidesoftware.com
 * @since 4.0
 */
public class SwiftBlock4 extends SwiftTagListBlock implements Serializable {
    private static final long serialVersionUID = -623730182521597955L;

    /**
     * Default constructor
     */
    public SwiftBlock4() {
    }

    /**
     * Constructor with tag initialization
     * @param tags the list of tags to initialize
     * @throws IllegalArgumentException if parameter tags is <code>null</code>
     * @throws IllegalArgumentException if parameter tags is not composed of Strings
     * @since 5.0
     */
    public SwiftBlock4(List<Tag> tags) {
        // sanity check
        Validate.notNull(tags, "parameter 'tags' cannot be null");
        Validate.allElementsOfType(tags, Tag.class, "parameter 'tags' may only have Tag elements");

        this.addTags(tags);
    }

    /**
     * Sets the block number. Will cause an exception unless setting block number to 4.
     * @param blockNumber the block number to set
     * @throws IllegalArgumentException if parameter blockName is not the integer 4
     * @since 5.0
     */
    protected void setBlockNumber(Integer blockNumber) {
        // sanity check
        Validate.notNull(blockNumber, "parameter 'blockNumber' cannot be null");
        Validate.isTrue(blockNumber.intValue() == 4, "blockNumber must be 4");
    }

    /**
     * Sets the block name. Will cause an exception unless setting block number to "4".
     * @param blockName the block name to set
     * @throws IllegalArgumentException if parameter blockName is not the string "4"
     * @since 5.0
     */
    protected void setBlockName(String blockName) {
        // sanity check
        Validate.notNull(blockName, "parameter 'blockName' cannot be null");
        Validate.isTrue(blockName.compareTo("4") == 0, "blockName must be string '4'");
    }

    /**
     * Returns the block number (the value 4 as an integer)
     * @return Integer containing the block's number
     */
    public Integer getNumber() {
        return new Integer(4);
    }

    /**
     * Returns the block name (the value 4 as a string)
     * @return block name
     * 
     * @since 5.0
     */
    public String getName() {
        return ("4");
    }

}