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 {
40 private static final long serialVersionUID = 1L;
41 private final String revision;
42 private final String name;
46 * Creates new YANG Schema source identifier.
48 * @param name Name of schema
49 * @param formattedRevision Revision of source in format YYYY-mm-dd
51 public SourceIdentifier(final String name, final Optional<String> formattedRevision) {
53 this.name = Preconditions.checkNotNull(name);
54 this.revision = formattedRevision.orNull();
62 public String getName() {
67 * Returns revision of source or null if revision was not supplied.
69 * @return revision of source or null if revision was not supplied.
71 public String getRevision() {
76 public int hashCode() {
79 result = prime * result + ((name == null) ? 0 : name.hashCode());
80 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
85 public boolean equals(final Object obj) {
92 if (getClass() != obj.getClass()) {
95 SourceIdentifier other = (SourceIdentifier) obj;
97 if (other.name != null) {
100 } else if (!name.equals(other.name)) {
103 if (revision == null) {
104 if (other.revision != null) {
107 } else if (!revision.equals(other.revision)) {
113 public static SourceIdentifier create(final String moduleName, final Optional<String> revision) {
114 return new SourceIdentifier(moduleName, revision);
118 * Returns filename for this YANG module as specified in RFC 6020.
120 * Returns filename in format
121 * <code>name ['@' revision] '.yang'</code>
123 * Where revision is date in format YYYY-mm-dd.
126 * @see http://tools.ietf.org/html/rfc6020#section-5.2
128 * @return Filename for this source identifier.
130 public String toYangFilename() {
131 return toYangFileName(name, Optional.fromNullable(revision));
135 public String toString() {
136 return "SourceIdentifier [name=" + name + "@" + revision + "]";
140 * Returns filename for this YANG module as specified in RFC 6020.
142 * Returns filename in format
143 * <code>moduleName ['@' revision] '.yang'</code>
145 * Where Where revision-date is in format YYYY-mm-dd.
149 * http://tools.ietf.org/html/rfc6020#section-5.2
151 * @return Filename for this source identifier.
153 public static final String toYangFileName(final String moduleName, final Optional<String> revision) {
154 StringBuilder filename = new StringBuilder(moduleName);
155 if (revision.isPresent()) {
156 filename.append('@');
157 filename.append(revision.get());
159 filename.append(".yang");
160 return filename.toString();