Seed yang-model-spi with model.util.type
[yangtools.git] / yang / yang-model-spi / src / main / java / org / opendaylight / yangtools / yang / model / spi / type / AbstractTypeDefinition.java
1 /*
2  * Copyright (c) 2015 Pantheon Technologies s.r.o. 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.spi.type;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.collect.ImmutableList;
13 import java.util.Collection;
14 import org.eclipse.jdt.annotation.NonNull;
15 import org.opendaylight.yangtools.concepts.Immutable;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
18 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
19
20 abstract class AbstractTypeDefinition<T extends TypeDefinition<T>> implements Immutable, TypeDefinition<T> {
21     private final @NonNull ImmutableList<UnknownSchemaNode> unknownSchemaNodes;
22     private final @NonNull QName qname;
23
24     AbstractTypeDefinition(final QName qname, final Collection<? extends UnknownSchemaNode> unknownSchemaNodes) {
25         this.qname = requireNonNull(qname);
26         this.unknownSchemaNodes = ImmutableList.copyOf(unknownSchemaNodes);
27     }
28
29     AbstractTypeDefinition(final AbstractTypeDefinition<T> original, final QName qname) {
30         this.unknownSchemaNodes = original.unknownSchemaNodes;
31         this.qname = requireNonNull(qname);
32     }
33
34     @Override
35     public final QName getQName() {
36         return qname;
37     }
38
39     @Override
40     public final Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
41         return unknownSchemaNodes;
42     }
43
44     /**
45      * Bind this type definition to a new {@link QName}. The resulting definition will be equivalent to this definition
46      * in all aspects except its path.
47      *
48      * @param newQName New {@link QName} to use
49      * @return Bound type definition
50      */
51     abstract @NonNull T bindTo(@NonNull QName newQName);
52
53     @Override
54     public abstract String toString();
55
56     @Override
57     public abstract int hashCode();
58
59     @Override
60     public abstract boolean equals(Object obj);
61 }