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/epl-v10.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;
13 import com.google.common.collect.Interner;
14 import com.google.common.collect.Interners;
15 import java.util.regex.Pattern;
16 import org.opendaylight.yangtools.concepts.Identifier;
17 import org.opendaylight.yangtools.concepts.Immutable;
18 import org.opendaylight.yangtools.concepts.SemVer;
19 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
22 * Base class of YANG Schema source identifiers.
24 * Source identifiers are designated to be carry only necessary information to
25 * look-up YANG model source and to be used by various SchemaSourceProviders.
27 * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2
28 * and http://tools.ietf.org/html/rfc6022#section-3.1 ).
31 public abstract class SourceIdentifier implements Identifier, Immutable {
33 * Default revision for sources without specified revision. Marks the source
36 public static final String NOT_PRESENT_FORMATTED_REVISION = "0000-00-00";
40 * Simplified compiled revision pattern in format YYYY-mm-dd, which checks
41 * only distribution of number elements.
43 * For checking if supplied string is real date, use
44 * {@link SimpleDateFormatUtil} instead.
47 public static final Pattern REVISION_PATTERN = Pattern.compile("\\d\\d\\d\\d-\\d\\d-\\d\\d");
49 private static final Interner<SourceIdentifier> INTERNER = Interners.newWeakInterner();
51 private static final long serialVersionUID = 1L;
52 private final String revision;
53 private final String name;
57 * Creates new YANG Schema source identifier for sources without revision.
58 * {@link SourceIdentifier#NOT_PRESENT_FORMATTED_REVISION} as default
64 SourceIdentifier(final String name) {
65 this(name, NOT_PRESENT_FORMATTED_REVISION);
69 * Creates new YANG Schema source identifier.
73 * @param formattedRevision
74 * Revision of source in format YYYY-mm-dd
76 SourceIdentifier(final String name, final String formattedRevision) {
77 this.name = Preconditions.checkNotNull(name);
78 this.revision = Preconditions.checkNotNull(formattedRevision);
83 * Creates new YANG Schema source identifier.
87 * @param formattedRevision
88 * Revision of source in format YYYY-mm-dd. If not present,
89 * default value will be used.
91 SourceIdentifier(final String name, final Optional<String> formattedRevision) {
92 this(name, formattedRevision.or(NOT_PRESENT_FORMATTED_REVISION));
96 * Return an interned reference to a equivalent SemVerSourceIdentifier.
98 * @return Interned reference, or this object if it was interned.
100 public SourceIdentifier intern() {
101 return INTERNER.intern(this);
109 public String getName() {
114 * Returns revision of source or null if revision was not supplied.
116 * @return revision of source or null if revision was not supplied.
118 public String getRevision() {
124 * Since we've got two ways of model versioning (revision & semantic version),
125 * this method shouldn't be called directly anymore. Eventually, callers of this method
126 * should be notified before method gets deleted.
127 * @deprecated use either
129 * <li>{@link SemVerSourceIdentifier#create(String, SemVer)}</li>
130 * <li>{@link SemVerSourceIdentifier#create(String, Optional, SemVer)}</li>
131 * <li>{@link SemVerSourceIdentifier#create(String, String, SemVer)}</li>
135 * <li>{@link RevisionSourceIdentifier#create(String)}</li>
136 * <li>{@link RevisionSourceIdentifier#create(String, String)}</li>
137 * <li>{@link RevisionSourceIdentifier#create(String, Optional)}</li>
144 * Revision of source in format YYYY-mm-dd. If not present,
145 * default value will be used.
147 * @return particular SourceIdentifier instance
151 public static SourceIdentifier create(final String moduleName, final Optional<String> revision) {
152 return new RevisionSourceIdentifier(moduleName, revision);
156 * Returns filename for this YANG module as specified in RFC 6020.
158 * Returns filename in format <code>name ['@' revision] '.yang'</code>
160 * Where revision is date in format YYYY-mm-dd.
163 * @see <a href="http://tools.ietf.org/html/rfc6020#section-5.2">RFC6020</a>
165 * @return Filename for this source identifier.
167 public String toYangFilename() {
168 return toYangFileName(name, Optional.fromNullable(revision));
172 * Returns filename for this YANG module as specified in RFC 6020.
174 * Returns filename in format <code>moduleName ['@' revision] '.yang'</code>
176 * Where Where revision-date is in format YYYY-mm-dd.
179 * See http://tools.ietf.org/html/rfc6020#section-5.2
181 * @return Filename for this source identifier.
183 public static 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();