yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeTip.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.data.api.schema.tree;
   9
  10 import com.google.common.annotations.Beta;
  11
  12 /**
  13  * Tip of a data tree instance. It acts as a point to which modifications can
  14  * be applied.
  15  */
  16 @Beta
  17 public interface DataTreeTip {
  18     /**
  19      * Validate whether a particular modification can be applied to the data tree.
  20      * @param modification
  21      *                  Data tree modification.
  22      * @throws DataValidationFailedException
  23      *                  If modification data is not valid.
  24      */
  25     void validate(DataTreeModification modification) throws DataValidationFailedException;
  26
  27     /**
  28      * Prepare a modification for commit.
  29      *
  30      * @param modification
  31      *                  Data tree modification.
  32      * @return candidate data tree
  33      */
  34     DataTreeCandidate prepare(DataTreeModification modification);
  35
  36     /**
  37      * {@inheritDoc}
  38      *
  39      * {@link DataTreeTip} implementations must not override the default identity hashCode method.
  40      */
  41     @Override
  42     int hashCode();
  43
  44     /**
  45      * {@inheritDoc}
  46      *
  47      * {@link DataTreeTip} implementations must not override the default identity hashCode method, meaning their
  48      * equals implementation must result in identity comparison.
  49      */
  50     @Override
  51     boolean equals(Object obj);
  52 }