2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.binding.model.api.type.builder;
10 import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty;
11 import org.opendaylight.controller.sal.binding.model.api.Type;
14 * Generated Property Builder is interface that contains methods to build and
15 * instantiate Generated Property definition.
17 * @see GeneratedProperty
19 public interface GeneratedPropertyBuilder extends TypeMemberBuilder {
22 * Sets isReadOnly flag for property. If property is marked as read only
23 * it is the same as set property in java as final.
25 * @param isReadOnly Read Only property flag.
27 public void setReadOnly(final boolean isReadOnly);
30 * Returns <code>new</code> <i>immutable</i> instance of Generated
33 * The <code>definingType</code> param cannot be <code>null</code>. The
34 * every member in Java MUST be declared and defined inside the scope of
35 * <code>class</code> definition. In case that
36 * defining Type will be passed as <code>null</code> reference the method
37 * SHOULD thrown {@link IllegalArgumentException}.
39 * @param definingType Defining Type of Generated Property
40 * @return <code>new</code> <i>immutable</i> instance of Generated
43 public GeneratedProperty toInstance(final Type definingType);