org.opendaylight.yangtools.yang.model.api.ModuleLike Maven / Gradle / Ivy
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.model.api;
import com.google.common.annotations.Beta;
import java.util.Collection;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.YangVersion;
/**
* This interface contains common methods for getting the schema contents from a YANG module or submodule.
*/
@Beta
public interface ModuleLike extends DataNodeContainer, DocumentedNode, Immutable, NotificationNodeContainer,
QNameModuleAware {
/**
* Returns the name of the module which is specified as argument of YANG {@code module} statement.
*
* @return string with the name of the module
*/
String getName();
/**
* Returns the prefix of the module.
*
* @return string with the module prefix which is specified as argument of YANG {@code prefix} statement
*/
String getPrefix();
/**
* Returns the YANG version.
*
* @return YANG version of this module.
*/
YangVersion getYangVersion();
/**
* Returns the module organization.
*
* @return string with the name of the organization specified in the module as the argument of YANG
* {@code organization} statement
*/
Optional getOrganization();
/**
* Returns the module contact.
*
*
* The contact represents the person or persons to whom technical queries concerning this module should be sent,
* such as their name, postal address, telephone number, and electronic mail address.
*
* @return string with the contact data specified in the module as the argument of YANG {@code contact} statement
*/
Optional getContact();
/**
* Returns imports which represents YANG modules which are imported to this module via {@code import} statement.
*
* @return set of module imports which are specified in the module as the argument of YANG {@code import}
* statements.
*/
Collection getImports();
// FIXME: YANGTOOLS-1006: this should be only in Module
Collection getSubmodules();
/**
* Returns {@link FeatureDefinition} instances which contain data from {@code feature} statements defined in the
* module.
*
*
* The feature is used to define a mechanism by which portions of the schema are marked as conditional.
*
* @return feature statements in lexicographical order which are specified in the module as the argument of YANG
* {@code feature} statements.
*/
Collection getFeatures();
/**
* Returns {@link AugmentationSchemaNode} instances which contain data from {@code augment} statements defined
* in the module.
*
* @return set of the augmentation schema instances which are specified in the module as YANG {@code augment}
* statement and are lexicographically ordered
*/
Collection getAugmentations();
/**
* Returns {@link RpcDefinition} instances which contain data from {@code rpc} statements defined in the module.
*
* @return set of the RPC definition instances which are specified in the module as YANG {@code rpc} statements and
* are lexicographicaly ordered
*/
Collection getRpcs();
/**
* Returns {@link Deviation} instances which contain data from {@code deviation} statements defined in the module.
*
* @return set of the deviation instances
*/
Collection getDeviations();
/**
* Returns {@link IdentitySchemaNode} instances which contain data from {@code identity} statements defined in the
* module.
*
* @return set of identity schema node instances which are specified in the module as YANG {@code identity}
* statements and are lexicographically ordered
*/
Collection getIdentities();
/**
* Returns {@link ExtensionDefinition} instances which contain data from {@code extension} statements defined in
* the module.
*
* @return set of extension definition instances which are specified in the module as YANG {@code extension}
* statements and are lexicographically ordered
*/
Collection getExtensionSchemaNodes();
}