Merge "Added tests for yang.model.util"
[yangtools.git] / code-generator / binding-model-api / src / main / java / org / opendaylight / yangtools / sal / binding / model / api / type / builder / GeneratedTypeBuilder.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.yangtools.sal.binding.model.api.type.builder;
9
10 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
11
12 /**
13  * Generated Type Builder interface is helper interface for building and
14  * defining the GeneratedType.
15  *
16  * @see GeneratedType
17  */
18 public interface GeneratedTypeBuilder extends GeneratedTypeBuilderBase<GeneratedTypeBuilder> {
19
20     /**
21      * Returns the <code>new</code> <i>immutable</i> instance of Generated Type.
22      *
23      * @return the <code>new</code> <i>immutable</i> instance of Generated Type.
24      */
25     GeneratedType toInstance();
26
27     /**
28      * Set true if generated type is suitable for boxing, false otherwise.
29      *
30      * @param value
31      */
32     public void setSuitableForBoxing(boolean value);
33
34     /**
35      * Set parent for current generated type.
36      *
37      * @param parent
38      */
39     public void setParentType(GeneratedTypeBuilder parent);
40 }