binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/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.mdsal.binding.model.api;
   9
  10 /**
  11  * Generated Property extends {@link TypeMember} interface with additional information about fields (and other members)
  12  * declared in Java Transfer Objects (or any java classes) and their access counterparts (getters and setters).
  13  *
  14  * @see TypeMember
  15  */
  16 // FIXME: 7.0.0: this interface (and others) need to be refactored:
  17 //               - getValue() is pretty much unused and its semantics are undefined
  18 //               - isReadOnly() is not related to getValue() and is not used together
  19 public interface GeneratedProperty extends TypeMember {
  20
  21     String getValue();
  22
  23     /**
  24      * Returns <code>true</code> if the property is declared as read-only. If this {@code true} the property should be
  25      * generated with only a getter.
  26      *
  27      * @return {@code true<} if the property is declared as read-only.
  28      */
  29     boolean isReadOnly();
  30 }