binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/type/builder/GeneratedPropertyBuilder.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.type.builder;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  12 import org.opendaylight.mdsal.binding.model.api.Type;
  13
  14 /**
  15  * Generated Property Builder is interface that contains methods to build and instantiate Generated Property definition.
  16  *
  17  * @see GeneratedProperty
  18  */
  19 public interface GeneratedPropertyBuilder extends TypeMemberBuilder<GeneratedPropertyBuilder> {
  20
  21     GeneratedPropertyBuilder setValue(String value);
  22
  23     /**
  24      * Sets isReadOnly flag for property. If property is marked as read only it is the same as set property in Java
  25      * as final.
  26      *
  27      * @param isReadOnly Read Only property flag.
  28      */
  29     GeneratedPropertyBuilder setReadOnly(boolean isReadOnly);
  30
  31     @Beta
  32     GeneratedPropertyBuilder setNullifyEmpty(boolean flag);
  33
  34     /**
  35      * Returns <code>new</code> <i>immutable</i> instance of Generated Property. <br>
  36      * The <code>definingType</code> param cannot be <code>null</code>. The
  37      * every member in Java MUST be declared and defined inside the scope of
  38      * <code>class</code> definition. In case that defining Type will be passed
  39      * as <code>null</code> reference the method SHOULD thrown
  40      * {@link IllegalArgumentException}.
  41      *
  42      * @param definingType Defining Type of Generated Property
  43      * @return <code>new</code> <i>immutable</i> instance of Generated Property.
  44      */
  45     GeneratedProperty toInstance(Type definingType);
  46 }