BUG-6533: add immutable implementations of yang.model.api
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / type / UnionTypeDefinition.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.yang.model.api.type;
9
10 import java.util.List;
11 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
12
13 /**
14  * Contains the method which access union item in the union type.
15  */
16 public interface UnionTypeDefinition extends TypeDefinition<UnionTypeDefinition> {
17
18     /**
19      * Returns type definitions which represent the values of the arguments for
20      * all YANG <code>type</code> substatement in the main <code>union</code>
21      * statement.
22      *
23      * @return list of the type definition which contains the union items.
24      */
25     List<TypeDefinition<?>> getTypes();
26 }