opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedProperty.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.sal.binding.model.api;\r
   9 \r
  10 /**\r
  11  * Generated Property extends interface {@link MethodSignature} interface.\r
  12  * <br>\r
  13  * The Generated Property interface is designed to store information of\r
  14  * fields (or members) declared in Java Transfer Objects (or any java\r
  15  * classes) and their access counterparts (getters and setters).\r
  16  *\r
  17  * @see MethodSignature\r
  18  */\r
  19 public interface GeneratedProperty extends TypeMember {\r
  20 \r
  21     /**\r
  22      * Returns <code>true</code> if the property si declared as read-only.\r
  23      * <br>\r
  24      * If the property has flag <code>isReadOnly == true</code> the property\r
  25      * SHOULD be generated as getter only.\r
  26      *\r
  27      * @return <code>true</code> if the property si declared as read-only.\r
  28      */\r
  29     public boolean isReadOnly();\r
  30 }\r