import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
-import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* (i.e. contains <code>null</code> values) the method will return
* IllegalArgumentException.
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param schemaPath
* Schema Path to search for
* @return SchemaNode from the end of the Schema Path or <code>null</code>
* if the Node is not present.
+ *
+ * @throws IllegalArgumentException
*/
public static SchemaNode findDataSchemaNode(final SchemaContext context, final SchemaPath schemaPath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
* method will return specified Data Schema Node, otherwise the operation
* will fail and method will return <code>null</code>.
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* @return Returns Data Schema Node for specified Schema Context for given
* Non-conditional Revision Aware XPath, or <code>null</code> if the
* DataSchemaNode is not present in Schema Context.
+ * @throws IllegalArgumentException
*/
- public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module, final RevisionAwareXPath nonCondXPath) {
+ public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module,
+ final RevisionAwareXPath nonCondXPath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(nonCondXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
final String strXPath = nonCondXPath.toString();
if (strXPath != null) {
- Preconditions.checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition");
+ Preconditions.checkArgument(strXPath.indexOf('[') == -1,
+ "Revision Aware XPath may not contain a condition");
if (nonCondXPath.isAbsolute()) {
final List<QName> qnamedPath = xpathToQNamePath(context, module, strXPath);
if (qnamedPath != null) {
* the method will return specified Data Schema Node, otherwise the
* operation will fail and method will return <code>null</code>.
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* @return DataSchemaNode if is present in specified Schema Context for
* given relative Revision Aware XPath, otherwise will return
* <code>null</code>.
+ *
+ * @throws IllegalArgumentException
*/
public static SchemaNode findDataSchemaNodeForRelativeXPath(final SchemaContext context, final Module module,
final SchemaNode actualSchemaNode, final RevisionAwareXPath relativeXPath) {
* If Schema Context or Schema Node contains <code>null</code> references
* the method will throw IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param schemaNode
* Schema Node
- * @return Yang Module for specified Schema Context and Schema Node, if
- * Schema Node is NOT present, the method will returns
- * <code>null</code>
+ * @return Yang Module for specified Schema Context and Schema Node, if Schema Node is NOT present, the method will
+ * return <code>null</code>
+ *
+ * @throws IllegalArgumentException
*/
public static Module findParentModule(final SchemaContext context, final SchemaNode schemaNode) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL!");
+ "set properly (Schema Path is NULL)");
final QName qname = schemaNode.getPath().getLastComponent();
- Preconditions.checkState(qname != null,
- "Schema Path contains invalid state of path parts. " +
- "The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
+ Preconditions.checkState(qname != null, "Schema Path contains invalid state of path parts. "
+ + "The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
return context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
}
* @return Notification schema or null, if notification is not present in schema context.
*/
@Beta
- @Nullable public static NotificationDefinition getNotificationSchema(@Nonnull final SchemaContext schema, @Nonnull final SchemaPath path) {
+ @Nullable public static NotificationDefinition getNotificationSchema(@Nonnull final SchemaContext schema,
+ @Nonnull final SchemaPath path) {
Preconditions.checkNotNull(schema, "Schema context must not be null.");
Preconditions.checkNotNull(path, "Schema path must not be null.");
for (final NotificationDefinition potential : schema.getNotifications()) {
* @return Notification schema or null, if notification is not present in schema context.
*/
@Beta
- @Nullable public static ContainerSchemaNode getRpcDataSchema(@Nonnull final SchemaContext schema, @Nonnull final SchemaPath path) {
+ @Nullable public static ContainerSchemaNode getRpcDataSchema(@Nonnull final SchemaContext schema,
+ @Nonnull final SchemaPath path) {
Preconditions.checkNotNull(schema, "Schema context must not be null.");
Preconditions.checkNotNull(path, "Schema path must not be null.");
final Iterator<QName> it = path.getPathFromRoot().iterator();
* If Schema Context, Parent Module or XPath string contains
* <code>null</code> values, the method will throws IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param parentModule
* @param xpath
* XPath String
* @return return a list of QName
+ *
+ * @throws IllegalArgumentException
*/
- private static List<QName> xpathToQNamePath(final SchemaContext context, final Module parentModule, final String xpath) {
+ private static List<QName> xpathToQNamePath(final SchemaContext context, final Module parentModule,
+ final String xpath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
Preconditions.checkArgument(xpath != null, "XPath string reference cannot be NULL");
- final List<QName> path = new LinkedList<QName>();
+ final List<QName> path = new LinkedList<>();
for (final String pathComponent : SLASH_SPLITTER.split(xpath)) {
if (!pathComponent.isEmpty()) {
path.add(stringPathPartToQName(context, parentModule, pathComponent));
* If Schema Context, Parent Module or Prefixed Path Part refers to
* <code>null</code> the method will throw IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param parentModule
* @param prefixedPathPart
* Prefixed Path Part string
* @return QName from prefixed Path Part String.
+ *
+ * @throws IllegalArgumentException
*/
- private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule, final String prefixedPathPart) {
+ private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule,
+ final String prefixedPathPart) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
Preconditions.checkArgument(prefixedPathPart != null, "Prefixed Path Part cannot be NULL!");
final String modulePrefix = prefixedName.next();
final Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
- Preconditions.checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
- modulePrefix, parentModule.getName());
+ Preconditions.checkArgument(module != null,
+ "Failed to resolve xpath: no module found for prefix %s in module %s", modulePrefix,
+ parentModule.getName());
return QName.create(module.getQNameModule(), prefixedName.next());
- } else {
- return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart);
}
+
+ return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart);
}
/**
* If Schema Context, Module or Prefix are referring to <code>null</code>
* the method will return IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* Module Prefix
* @return Module for given prefix in specified Schema Context if is
* present, otherwise returns <code>null</code>
+ *
+ * @throws IllegalArgumentException
*/
- private static Module resolveModuleForPrefix(final SchemaContext context, final Module module, final String prefix) {
+ private static Module resolveModuleForPrefix(final SchemaContext context, final Module module,
+ final String prefix) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(prefix != null, "Prefix string cannot be NULL");
}
/**
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* @param actualSchemaNode
* actual schema node
* @return list of QName
+ *
+ * @throws IllegalArgumentException
*/
private static Iterable<QName> resolveRelativeXPath(final SchemaContext context, final Module module,
final RevisionAwareXPath relativeXPath, final SchemaNode actualSchemaNode) {
if (Iterables.size(schemaNodePath) - colCount >= 0) {
return Iterables.concat(Iterables.limit(schemaNodePath, Iterables.size(schemaNodePath) - colCount),
- Iterables.transform(Iterables.skip(xpaths, colCount), new Function<String, QName>() {
- @Override
- public QName apply(final String input) {
- return stringPathPartToQName(context, module, input);
- }
- }));
+ Iterables.transform(Iterables.skip(xpaths, colCount),
+ input -> stringPathPartToQName(context, module, input)));
}
return Iterables.concat(schemaNodePath,
- Iterables.transform(Iterables.skip(xpaths, colCount), new Function<String, QName>() {
- @Override
- public QName apply(final String input) {
- return stringPathPartToQName(context, module, input);
- }
- }));
+ Iterables.transform(Iterables.skip(xpaths, colCount),
+ input -> stringPathPartToQName(context, module, input)));
}
/**
- * Extracts the base type of node on which schema node points to. If target node is again of type LeafrefTypeDefinition, methods will be call recursively until it reach concrete
- * type definition.
+ * Extracts the base type of node on which schema node points to. If target node is again of type
+ * LeafrefTypeDefinition, methods will be call recursively until it reach concrete type definition.
*
* @param typeDefinition
* type of node which will be extracted
* Schema Context
* @param schema
* Schema Node
- * @return recursively found type definition this leafref is pointing to or null if the xpath is incorrect (null is there to preserve backwards compatibility)
+ * @return recursively found type definition this leafref is pointing to or null if the xpath is incorrect (null
+ * is there to preserve backwards compatibility)
*/
- public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition, final SchemaContext schemaContext, final SchemaNode schema) {
+ public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition,
+ final SchemaContext schemaContext, final SchemaNode schema) {
RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
- pathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
+ pathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement),
+ pathStatement.isAbsolute());
final DataSchemaNode dataSchemaNode;
if (pathStatement.isAbsolute()) {
// FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths
// and current expected behaviour for such cases is to just use pure string
// This should throw an exception about incorrect XPath in leafref
- if(dataSchemaNode == null) {
+ if (dataSchemaNode == null) {
return null;
}
final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
- if(targetTypeDefinition instanceof LeafrefTypeDefinition) {
+ if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
return getBaseTypeForLeafRef(((LeafrefTypeDefinition) targetTypeDefinition), schemaContext, dataSchemaNode);
- } else {
- return targetTypeDefinition;
}
+
+ return targetTypeDefinition;
}
private static Module findParentModuleOfReferencingType(final SchemaContext schemaContext,
final SchemaNode schemaNode) {
Preconditions.checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
- Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
- TypeDefinition<?> nodeType = null;
+ Preconditions.checkArgument(schemaNode instanceof TypedSchemaNode, "Unsupported node %s", schemaNode);
- if (schemaNode instanceof LeafSchemaNode) {
- nodeType = ((LeafSchemaNode) schemaNode).getType();
- } else if (schemaNode instanceof LeafListSchemaNode) {
- nodeType = ((LeafListSchemaNode) schemaNode).getType();
- }
-
- if (nodeType instanceof ExtendedType) {
- while (nodeType.getBaseType() instanceof ExtendedType) {
- nodeType = nodeType.getBaseType();
- }
-
- QNameModule typeDefModuleQname = nodeType.getQName().getModule();
- return schemaContext.findModuleByNamespaceAndRevision(typeDefModuleQname.getNamespace(),
- typeDefModuleQname.getRevision());
- } else if (nodeType.getBaseType() != null) {
+ TypeDefinition<?> nodeType = ((TypedSchemaNode) schemaNode).getType();
+ if (nodeType.getBaseType() != null) {
while (nodeType.getBaseType() != null) {
nodeType = nodeType.getBaseType();
}
}
/**
- * @deprecated due to expensive lookup
- * Returns parent Yang Module for specified Schema Context in which Schema
- * Node is declared. If Schema Node is of type 'ExtendedType' it tries to find parent module
- * in which the type was originally declared (needed for correct leafref path resolution). <br>
- * If the Schema Node is not present in Schema Context the
- * operation will return <code>null</code>. <br>
- * If Schema Context or Schema Node contains <code>null</code> references
- * the method will throw IllegalArgumentException
- *
- * @throws IllegalArgumentException
- *
- * @param schemaContext
- * Schema Context
- * @param schemaNode
- * Schema Node
- * @return Yang Module for specified Schema Context and Schema Node, if
- * Schema Node is NOT present, the method will returns
- * <code>null</code>
- */
- @Deprecated
- public static Module findParentModuleByType(final SchemaContext schemaContext, final SchemaNode schemaNode) {
- Preconditions.checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
- Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
- TypeDefinition<?> nodeType = null;
-
- if (schemaNode instanceof LeafSchemaNode) {
- nodeType = ((LeafSchemaNode) schemaNode).getType();
- } else if (schemaNode instanceof LeafListSchemaNode) {
- nodeType = ((LeafListSchemaNode) schemaNode).getType();
- }
-
- if (!BaseTypes.isYangBuildInType(nodeType) && nodeType.getBaseType() != null) {
- while (nodeType.getBaseType() != null && !BaseTypes.isYangBuildInType(nodeType.getBaseType())) {
- nodeType = nodeType.getBaseType();
- }
-
- QNameModule typeDefModuleQname = nodeType.getQName().getModule();
-
- return schemaContext.findModuleByNamespaceAndRevision(typeDefModuleQname.getNamespace(),
- typeDefModuleQname.getRevision());
- }
-
- return SchemaContextUtil.findParentModule(schemaContext, schemaNode);
- }
-
- /**
- * Returns base type for {@code typeDefinition} which belongs to module specified via {@code qName}. This handle case
- * when leafref type isn't specified as type substatement of leaf or leaf-list but is defined in other module as typedef
- * which is then imported to referenced module.
+ * Returns base type for {@code typeDefinition} which belongs to module specified via {@code qName}. This handle
+ * the case when leafref type isn't specified as type substatement of leaf or leaf-list but is defined in other
+ * module as typedef which is then imported to referenced module.
*
* Because {@code typeDefinition} is definied via typedef statement, only absolute path is meaningful.
*
* @param typeDefinition
* @param schemaContext
* @param qName
- * @return
*/
public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition,
final SchemaContext schemaContext, final QName qName) {
final RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
- final RevisionAwareXPath strippedPathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
+ final RevisionAwareXPath strippedPathStatement = new RevisionAwareXPathImpl(
+ stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
if (!strippedPathStatement.isAbsolute()) {
return null;
}
- final Module parentModule = schemaContext.findModuleByNamespaceAndRevision(qName.getNamespace(),qName.getRevision());
- final DataSchemaNode dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule, strippedPathStatement);
+ final Module parentModule = schemaContext.findModuleByNamespaceAndRevision(qName.getNamespace()
+ ,qName.getRevision());
+ final DataSchemaNode dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext,
+ parentModule, strippedPathStatement);
final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
return getBaseTypeForLeafRef(((LeafrefTypeDefinition) targetTypeDefinition), schemaContext, dataSchemaNode);
- } else {
- return targetTypeDefinition;
}
+
+ return targetTypeDefinition;
}
private static final Pattern STRIP_PATTERN = Pattern.compile("\\[[^\\[\\]]*\\]");
* a node representing LeafSchemaNode
* @return concrete type definition of node value
*/
- private static TypeDefinition<? extends Object> typeDefinition(final LeafSchemaNode node) {
+ private static TypeDefinition<?> typeDefinition(final LeafSchemaNode node) {
TypeDefinition<?> baseType = node.getType();
while (baseType.getBaseType() != null) {
baseType = baseType.getBaseType();
* a node representing LeafListSchemaNode
* @return concrete type definition of node value
*/
- private static TypeDefinition<? extends Object> typeDefinition(final LeafListSchemaNode node) {
+ private static TypeDefinition<?> typeDefinition(final LeafListSchemaNode node) {
TypeDefinition<?> baseType = node.getType();
while (baseType.getBaseType() != null) {
baseType = baseType.getBaseType();
* a node representing DataSchemaNode
* @return concrete type definition of node value
*/
- private static TypeDefinition<? extends Object> typeDefinition(final DataSchemaNode node) {
+ private static TypeDefinition<?> typeDefinition(final DataSchemaNode node) {
if (node instanceof LeafListSchemaNode) {
return typeDefinition((LeafListSchemaNode) node);
} else if (node instanceof LeafSchemaNode) {
return typeDefinition((LeafSchemaNode) node);
} else {
- throw new IllegalArgumentException("Unhandled parameter types: " + Collections.<Object>singletonList(node).toString());
+ throw new IllegalArgumentException("Unhandled parameter type: " + node);
}
}
}