/*
* Copyright (c) 2014 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.collect.ImmutableList;
import java.util.Collection;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
/**
* Node which can have documentation assigned.
*/
public interface DocumentedNode {
/**
* Returns the value of the argument of YANG description
keyword.
*
* @return string with the description, or empty if description was not provided.
*/
Optional getDescription();
/**
* Returns the value of the argument of YANG reference
keyword.
*
* @return string with reference to some other document, or empty if reference was not provided.
*/
Optional getReference();
/**
* Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty collection.
*
* @return collection of unknown schema nodes defined under this node.
*/
default @NonNull Collection extends UnknownSchemaNode> getUnknownSchemaNodes() {
return ImmutableList.of();
}
interface WithStatus extends DocumentedNode {
/**
* Returns status of the instance of the type SchemaNode
.
*
* @return status of this node which represents the argument of the YANG
* status
substatement
*/
@NonNull Status getStatus();
}
}