MsdlFile.java

/* Copyright (c) 2011 Danish Maritime Authority.
 *
 * 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 net.maritimecloud.msdl.model;

import java.util.List;

/**
 * A MSDL file corresponds to a single physical '.msdl' file.
 *
 * @author Kasper Nielsen
 */
public interface MsdlFile {

    String getName();

    /**
     * Returns a list of all broadcast messages defined in the MSDL file.
     *
     * @return a list of all broadcast messages defined in the MSDL file
     */
    List<BroadcastMessageDeclaration> getBroadcasts();

    /**
     * Returns a list of all endpoints defined in the MSDL file.
     *
     * @return a list of all endpoints defined in the MSDL file
     */
    List<EndpointDefinition> getEndpoints();

    /**
     * Returns a list of all enums defined in the MSDL file.
     *
     * @return a list of all enums defined in the MSDL file
     */
    List<EnumDeclaration> getEnums();

    /**
     * Returns a list of all messages defined in the MSDL file.
     *
     * @return a list of all messages defined in the MSDL file
     */
    List<MessageDeclaration> getMessages();

    /**
     * Returns any namespace that has been defined in the MSDL file. Returns <code>null</code> if no namespace has been
     * defined.
     *
     * @return any namespace that has been defined in the MSDL file
     */
    String getNamespace();
}