code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedTransferObject.java

   1 /*
   2  * Copyright (c) 2013 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.sal.binding.model.api;
   9
  10 import java.util.List;
  11
  12 /**
  13  * Generated Transfer Object extends {@link GeneratedType} and is designed to
  14  * represent Java Class. The Generated Transfer Object contains declarations of
  15  * member fields stored in List of Properties. The Generated Transfer Object can
  16  * be extended by exactly ONE Generated Transfer Object as Java don't allow
  17  * multiple inheritance. For retrieval of implementing Generated Types use
  18  * {@link #getImplements()} method. <br>
  19  * Every transfer object SHOULD contain equals, hashCode and toString
  20  * definitions. For this purpose retrieve definitions through
  21  * {@link #getEqualsIdentifiers ()}, {@link #getHashCodeIdentifiers()} and
  22  * {@link #getToStringIdentifiers ()}.
  23  *
  24  */
  25 public interface GeneratedTransferObject extends GeneratedType {
  26
  27     GeneratedProperty getSUID();
  28
  29     /**
  30      * Returns the extending Generated Transfer Object or <code>null</code> if
  31      * there is no extending Generated Transfer Object.
  32      *
  33      * @return the extending Generated Transfer Object or <code>null</code> if
  34      *         there is no extending Generated Transfer Object.
  35      */
  36     GeneratedTransferObject getSuperType();
  37
  38     /**
  39      * Returns List of Properties that are designated to define equality for
  40      * Generated Transfer Object.
  41      *
  42      * @return List of Properties that are designated to define equality for
  43      *         Generated Transfer Object.
  44      */
  45     List<GeneratedProperty> getEqualsIdentifiers();
  46
  47     /**
  48      * Returns List of Properties that are designated to define identity for
  49      * Generated Transfer Object.
  50      *
  51      * @return List of Properties that are designated to define identity for
  52      *         Generated Transfer Object.
  53      */
  54     List<GeneratedProperty> getHashCodeIdentifiers();
  55
  56     /**
  57      * Returns List of Properties that will be members of toString definition
  58      * for Generated Transfer Object.
  59      *
  60      * @return List of Properties that will be members of toString definition
  61      *         for Generated Transfer Object.
  62      */
  63     List<GeneratedProperty> getToStringIdentifiers();
  64
  65     boolean isTypedef();
  66
  67     /**
  68      * Return boolean value which describe whether Generated Transfer Object
  69      * was/wasn't created from union YANG type.
  70      *
  71      * @return true value if Generated Transfer Object was created from union
  72      *         YANG type.
  73      */
  74     @Deprecated
  75     boolean isUnionType();
  76
  77     Restrictions getRestrictions();
  78 }