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 pw-swift-core Show documentation
Prowide Library for SWIFT messages
The newest version!
/*
 * Copyright 2006-2023 Prowide
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.prowidesoftware.swift.model;

import java.io.Serializable;
import java.util.logging.Level;

/**
 * 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 sebastian
 * @since 4.0
 */
public abstract class SwiftValueBlock extends SwiftBlock implements Serializable {
    private static final long serialVersionUID = -3680693640473937755L;

    @SuppressWarnings("unused")
    private static final transient java.util.logging.Logger log =
            java.util.logging.Logger.getLogger(SwiftValueBlock.class.getName());

    /**
     * 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
     *
     * @param value unused
     */
    public void setBlockValue(final String value) {
        throw new UnsupportedOperationException(
                "cannot call setBlockValue 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");
    }

    /**
     * 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
            int boundedSize;
            if (start + size >= value.length()) {
                boundedSize = value.length() - start;
            } else {
                boundedSize = size;
            }

            // get the fragment
            try {
                s = value.substring(start, start + boundedSize);
            } catch (final IndexOutOfBoundsException e) {
                log.log(Level.SEVERE, "Exception parsing value part", e);
            }
        }
        return s;
    }

    /**
     * Returns a fragment of the block value received from a starting index until the end of value
     * (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
     * @return the value fragment or null if value is not large enough
     * @since 7.7
     */
    protected String getValuePart(final String value, final int start) {
        // check start is within bounds
        if (start < value.length()) {
            return value.substring(start);
        }
        return null;
    }
}