2 * Copyright (c) 2014 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/eplv10.html
8 package org.opendaylight.yangtools.yang.model.repo.api;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
14 import org.opendaylight.yangtools.concepts.Identifier;
15 import org.opendaylight.yangtools.concepts.Immutable;
18 * YANG Schema source identifier
20 * Simple transfer object represents identifier of source for YANG schema (module or submodule),
23 * <li>YANG schema name ({@link #getName()}
24 * <li>Module revision (optional) ({link {@link #getRevision()})
27 * Source identifier is designated to be carry only necessary information
28 * to look-up YANG model source and to be used by {@link AdvancedSchemaSourceProvider}
31 * <b>Note:</b>On source retrieval layer it is impossible to distinguish
32 * between YANG module and/or submodule unless source is present.
35 * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2 and
36 * http://tools.ietf.org/html/rfc6022#section-3.1 ).
39 public final class SourceIdentifier implements Identifier, Immutable {
42 * Default revision for sources without specified revision.
43 * Marks the source as oldest.
45 public static final String NOT_PRESENT_FORMATTED_REVISION = "0000-00-00";
47 private static final long serialVersionUID = 1L;
48 private final String revision;
49 private final String name;
53 * Creates new YANG Schema source identifier.
55 * @param name Name of schema
56 * @param formattedRevision Revision of source in format YYYY-mm-dd
58 public SourceIdentifier(final String name, final String formattedRevision) {
60 this.name = Preconditions.checkNotNull(name);
61 this.revision = Preconditions.checkNotNull(formattedRevision);
66 * Creates new YANG Schema source identifier.
68 * @param name Name of schema
69 * @param formattedRevision Revision of source in format YYYY-mm-dd. If not present, default value will be used.
71 public SourceIdentifier(final String name, final Optional<String> formattedRevision) {
72 this(name, formattedRevision.or(NOT_PRESENT_FORMATTED_REVISION));
77 * Creates new YANG Schema source identifier for sources without revision.
78 * {@link SourceIdentifier#NOT_PRESENT_FORMATTED_REVISION} as default revision.
80 * @param name Name of schema
82 public SourceIdentifier(final String name) {
83 this(name, NOT_PRESENT_FORMATTED_REVISION);
92 public String getName() {
97 * Returns revision of source or null if revision was not supplied.
99 * @return revision of source or null if revision was not supplied.
101 public String getRevision() {
106 public int hashCode() {
107 final int prime = 31;
109 result = prime * result + ((name == null) ? 0 : name.hashCode());
110 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
115 public boolean equals(final Object obj) {
122 if (getClass() != obj.getClass()) {
125 SourceIdentifier other = (SourceIdentifier) obj;
127 if (other.name != null) {
130 } else if (!name.equals(other.name)) {
133 if (revision == null) {
134 if (other.revision != null) {
137 } else if (!revision.equals(other.revision)) {
143 public static SourceIdentifier create(final String moduleName, final Optional<String> revision) {
144 return new SourceIdentifier(moduleName, revision);
148 * Returns filename for this YANG module as specified in RFC 6020.
150 * Returns filename in format
151 * <code>name ['@' revision] '.yang'</code>
153 * Where revision is date in format YYYY-mm-dd.
156 * @see http://tools.ietf.org/html/rfc6020#section-5.2
158 * @return Filename for this source identifier.
160 public String toYangFilename() {
161 return toYangFileName(name, Optional.fromNullable(revision));
165 public String toString() {
166 return "SourceIdentifier [name=" + name + "@" + revision + "]";
170 * Returns filename for this YANG module as specified in RFC 6020.
172 * Returns filename in format
173 * <code>moduleName ['@' revision] '.yang'</code>
175 * Where Where revision-date is in format YYYY-mm-dd.
179 * http://tools.ietf.org/html/rfc6020#section-5.2
181 * @return Filename for this source identifier.
183 public static final String toYangFileName(final String moduleName, final Optional<String> revision) {
184 StringBuilder filename = new StringBuilder(moduleName);
185 if (revision.isPresent()) {
186 filename.append('@');
187 filename.append(revision.get());
189 filename.append(".yang");
190 return filename.toString();