javax.validation.Path Maven / Gradle / Ivy
/*
* Copyright © 2018 The GWT Authors
*
* 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 javax.validation;
/**
* Represent the navigation path from an object to another in an object graph. Each path element is
* represented by a Node.
*
* The path corresponds to the succession of nodes in the order they are returned by the
* Iterator
*
* @author Emmanuel Bernard
*/
public interface Path extends Iterable {
/** Represents an element of a navigation path */
interface Node {
/**
* Property name the node represents or null if representing an entity on the leaf node (in
* particular the node in a Path representing the root object has its name null).
*
* @return property name the node represents
*/
String getName();
/** @return true if the node represents an object contained in an Iterable or in a Map. */
boolean isInIterable();
/** @return The index the node is placed in if contained in an array or List. Null otherwise. */
Integer getIndex();
/** @return The key the node is placed in if contained in a Map. Null otherwise. */
Object getKey();
}
}