org.ccsds.moims.mo.mal.MALArea 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.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.ccsds.moims.mo.mal.structures.Identifier;
import org.ccsds.moims.mo.mal.structures.UOctet;
import org.ccsds.moims.mo.mal.structures.UShort;

/**
 * Represents a MAL Area and holds information relating to the area.
 */
public class MALArea {

    private final UShort number;
    private final Identifier name;
    private final UOctet version;
    private final ArrayList services = new ArrayList<>();
    private final Map serviceNumbers = new HashMap<>();

    /**
     * MALArea constructor.
     *
     * @param number The number of the area.
     * @param name The name of the area.
     * @param version The area version.
     * @throws IllegalArgumentException If either argument is null.
     */
    public MALArea(final UShort number, final Identifier name, final UOctet version)
            throws java.lang.IllegalArgumentException {
        if (number == null) {
            throw new IllegalArgumentException("Number argument must not be NULL");
        }
        if (name == null) {
            throw new IllegalArgumentException("Name argument must not be NULL");
        }
        if (version == null) {
            throw new IllegalArgumentException("Version argument must not be NULL");
        }

        this.number = number;
        this.name = name;
        this.version = version;
    }

    /**
     * Returns the number of this Area.
     *
     * @return The MAL Area number.
     */
    public final UShort getNumber() {
        return number;
    }

    /**
     * Returns the name of this Area.
     *
     * @return The MAL Area name.
     */
    public final Identifier getName() {
        return name;
    }

    /**
     * Returns the version of the area.
     *
     * @return The service version.
     */
    public UOctet getVersion() {
        return version;
    }

    /**
     * Returns the services in this MAL Area.
     *
     * @return The services in this MAL Area.
     */
    public final ArrayList getServices() {
        return services;
    }

    /**
     * Returns a contained service identified by its number.
     *
     * @param serviceNumber The number of the service to find.
     * @return The found service or null if not found.
     */
    public synchronized MALService getServiceByNumber(final UShort serviceNumber) {
        return serviceNumbers.get(serviceNumber.getValue());
    }

    /**
     * Adds a service to this Area.
     *
     * @param service The MALService object to add.
     * @throws IllegalArgumentException Thrown if argument is NULL.
     * @throws MALException Thrown if service is already contained.
     */
    public synchronized void addService(final MALService service) throws IllegalArgumentException, MALException {
        if (!serviceNumbers.containsKey(service.getServiceNumber().getValue())) {
            //service.setArea(this);
            services.add(service);
            serviceNumbers.put(service.getServiceNumber().getValue(), service);
            //serviceNames.put(service.getName().getValue(), service);
        } else {
            // throw new MALException("Service already included in area");
            // Just log a message instead of throwing an exception!
            Logger.getLogger(MALArea.class.getName()).log(Level.WARNING,
                    "Service already included in area! Service: {0}", service.getName());
        }
    }
}