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

Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation

Prowide Core Libraries for SWIFT (TM) messages

There is a newer version: SRU2023-10.1.16

/*
 * 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;

/**
 * Base class for hierarchy of specific MT and MX classes.
 *
 * @author sebastian
 */
public abstract class AbstractMessage {

    MessageStandardType type = null;

    /**
     * Protected constructor necessary for jaxb in MX.
     */
    protected AbstractMessage() {}

    /**
     * Constructor for an {@link MessageStandardType#MT} or {@link MessageStandardType#MX} message.
     * @param type message type
     */
    protected AbstractMessage(MessageStandardType type) {
        this.type = type;
    }

    /**
     * Serialize this message into its raw SWIFT format: FIN for MT and XML for MX
     *
     * @return the message content
     * @since 8.0.2
     */
    public abstract String message();

    /**
     * @return true if the message is an MT, false otherwise
     */
    public boolean isMT() {
        return this.type == MessageStandardType.MT;
    }

    /**
     * @return true if the message is an MX, false otherwise
     */
    public boolean isMX() {
        return this.type == MessageStandardType.MX;
    }

    /**
     * @return the standard enumeration value corresponding to this message
     */
    public MessageStandardType getMessageStandardType() {
        return this.type;
    }
}