code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/GeneratedProperty.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 /**
  11  * Generated Property extends interface {@link MethodSignature} interface. <br>
  12  * The Generated Property interface is designed to store information of fields
  13  * (or members) declared in Java Transfer Objects (or any java classes) and
  14  * their access counterparts (getters and setters).
  15  *
  16  * @see MethodSignature
  17  */
  18 public interface GeneratedProperty extends TypeMember {
  19
  20     /**
  21      * Returns <code>true</code> if the property si declared as read-only. <br>
  22      * If the property has flag <code>isReadOnly == true</code> the property
  23      * SHOULD be generated as getter only.
  24      *
  25      * @return <code>true</code> if the property si declared as read-only.
  26      */
  27     boolean isReadOnly();
  28 }