org.ccsds.moims.mo.mal.MALStandardError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-mal Show documentation
An implementation of the Java API for the CCSDS MAL
There is a newer version: 10.1
/* ----------------------------------------------------------------------------
 * Copyright (C) 2013      European Space Agency
 *                         European Space Operations Centre
 *                         Darmstadt
 *                         Germany
 * ----------------------------------------------------------------------------
 * System                : CCSDS MO MAL Java API
 * ----------------------------------------------------------------------------
 * Licensed under the European Space Agency Public License, Version 2.0
 * You may not use this file except in compliance with the License.
 *
 * Except as expressly set forth in this License, the Software is provided to
 * You on an "as is" basis and without warranties of any kind, including without
 * limitation merchantability, fitness for a particular purpose, absence of
 * defects or errors, accuracy or non-infringement of intellectual property rights.
 * 
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 * ----------------------------------------------------------------------------
 */
package org.ccsds.moims.mo.mal;

import java.io.Serializable;
import org.ccsds.moims.mo.mal.structures.Attribute;
import org.ccsds.moims.mo.mal.structures.Identifier;
import org.ccsds.moims.mo.mal.structures.UInteger;

/**
 * Represents a MAL error.
 */
public class MALStandardError implements Serializable {

    private final UInteger errorNumber;
    private final Object extraInformation;
    private static final long serialVersionUID = Attribute.ABSOLUTE_AREA_SERVICE_NUMBER + 100;

    /**
     * Creates a standard error object with the supplied error number and extra
     * information.
     *
     * @param errorNumber The MAL error number, must not be null.
     * @param extraInformation Any associated extra information, may be null.
     * @throws java.lang.IllegalArgumentException Thrown if supplied error
     * number is null.
     */
    public MALStandardError(final UInteger errorNumber, final Object extraInformation)
            throws java.lang.IllegalArgumentException {
        if (errorNumber == null) {
            throw new IllegalArgumentException("Number argument must not be NULL");
        }

        this.errorNumber = errorNumber;
        this.extraInformation = extraInformation;
    }

    /**
     * Returns the supplied error number.
     *
     * @return The error number.
     */
    public UInteger getErrorNumber() {
        return errorNumber;
    }

    /**
     * Returns the supplied extra information.
     *
     * @return The extra information.
     */
    public Object getExtraInformation() {
        return extraInformation;
    }

    /**
     * Looks up the associated error name for the error number associated with
     * this standard error.
     *
     * @return The error name or null if not known.
     */
    public Identifier getErrorName() {
        return MALContextFactory.lookupError(errorNumber);
    }

    @Override
    public String toString() {
        final StringBuilder buf = new StringBuilder();

        buf.append("(");
        buf.append("errorNumber=");
        buf.append(errorNumber);
        buf.append(",errorName=");
        buf.append(MALContextFactory.lookupError(errorNumber));
        buf.append(",extraInformation=");
        buf.append(extraInformation);
        buf.append(")");

        return buf.toString();
    }
}