binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding2/model/api/GeneratedProperty.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.mdsal.binding2.model.api;
  10
  11 import com.google.common.annotations.Beta;
  12
  13 /**
  14  * Generated Property extends interface {@link TypeMember} interface. <br>
  15  * The Generated Property interface is designed to store information of fields
  16  * (or members) declared in Java Transfer Objects (or any java classes) and
  17  * their access counterparts (getters and setters).
  18  *
  19  * @see MethodSignature
  20  */
  21 @Beta
  22 public interface GeneratedProperty extends TypeMember {
  23
  24     /**
  25      * @return String format of generated property value
  26      */
  27     String getValue();
  28
  29     /**
  30      * Returns <code>true</code> if the property si declared as read-only. <br>
  31      * If the property has flag <code>isReadOnly == true</code> the property
  32      * SHOULD be generated as getter only.
  33      *
  34      * @return <code>true</code> if the property si declared as read-only.
  35      */
  36     boolean isReadOnly();
  37 }