/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.sal.binding.model.api.type.builder;
import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty;
import org.opendaylight.controller.sal.binding.model.api.Type;
/**
* Generated Property Builder is interface that contains methods to build and
* instantiate Generated Property definition.
*
* @see GeneratedProperty
*/
public interface GeneratedPropertyBuilder extends TypeMemberBuilder {
/**
* Sets isReadOnly flag for property. If property is marked as read only
* it is the same as set property in java as final.
*
* @param isReadOnly Read Only property flag.
*/
public void setReadOnly(final boolean isReadOnly);
/**
* Returns new
immutable instance of Generated
* Property.
*
* The definingType
param cannot be null
. The
* every member in Java MUST be declared and defined inside the scope of
* class
definition. In case that
* defining Type will be passed as null
reference the method
* SHOULD thrown {@link IllegalArgumentException}.
*
* @param definingType Defining Type of Generated Property
* @return new
immutable instance of Generated
* Property.
*/
public GeneratedProperty toInstance(final Type definingType);
}