org.onosproject.yang.runtime.ModelRegistrationParam Maven / Gradle / Ivy
/*
* Copyright 2017-present Open Networking Foundation
*
* 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 org.onosproject.yang.runtime;
import org.onosproject.yang.model.YangModel;
import org.onosproject.yang.model.YangModuleId;
/**
* Representation of model registration parameters.
*/
public interface ModelRegistrationParam {
/**
* Returns YANG model.
*
* @return YANG model
*/
YangModel getYangModel();
/**
* Returns extended app related information of a module/sub-module.
*
* @param id YANG module identifier
* @return application module information
*/
AppModuleInfo getAppModuleInfo(YangModuleId id);
/**
* Returns true for empty map. When application is being registered using
* model demo application then app info map will be empty.
*
* @return true for empty map
*/
boolean ifAppInfoPresent();
/**
* Abstraction of an entity that represents builder of model registration
* parameters.
*/
interface Builder {
/**
* Adds application module information associated with module identifier.
* It's expected that application should provide information for all the
* YANG modules.
*
* @param id YANG module identifier
* @param info application information associated with module identifier
* @return builder
*/
Builder addAppModuleInfo(YangModuleId id, AppModuleInfo info);
/**
* Sets YANG model.
*
* @param model YANG model
* @return builder
*/
Builder setYangModel(YangModel model);
/**
* Builds an instance of model registration param.
*
* @return model registration param
*/
ModelRegistrationParam build();
}
}