import com.google.common.annotations.Beta;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
+import com.google.common.collect.Interner;
+import com.google.common.collect.Interners;
import java.util.regex.Pattern;
import org.opendaylight.yangtools.concepts.Identifier;
import org.opendaylight.yangtools.concepts.Immutable;
-import org.opendaylight.yangtools.objcache.ObjectCache;
-import org.opendaylight.yangtools.objcache.ObjectCacheFactory;
+import org.opendaylight.yangtools.concepts.SemVer;
import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
/**
- * YANG Schema source identifier
+ * Base class of YANG Schema source identifiers.
*
- * Simple transfer object represents identifier of source for YANG schema (module or submodule),
- * which consists of
- * <ul>
- * <li>YANG schema name ({@link #getName()}
- * <li>Module revision (optional) ({link {@link #getRevision()})
- * </ul>
+ * Source identifiers are designated to be carry only necessary information to
+ * look-up YANG model source and to be used by various SchemaSourceProviders.
*
- * Source identifier is designated to be carry only necessary information
- * to look-up YANG model source and to be used by various SchemaSourceProviders.
- *
- * <b>Note:</b>On source retrieval layer it is impossible to distinguish
- * between YANG module and/or submodule unless source is present.
- *
- * <p>
- * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2 and
- * http://tools.ietf.org/html/rfc6022#section-3.1 ).
+ * (For further reference see: http://tools.ietf.org/html/rfc6020#section-5.2
+ * and http://tools.ietf.org/html/rfc6022#section-3.1 ).
*/
@Beta
-public final class SourceIdentifier implements Identifier, Immutable {
+public abstract class SourceIdentifier implements Identifier, Immutable {
/**
- * Default revision for sources without specified revision.
- * Marks the source as oldest.
+ * Default revision for sources without specified revision. Marks the source
+ * as oldest.
*/
public static final String NOT_PRESENT_FORMATTED_REVISION = "0000-00-00";
* Simplified compiled revision pattern in format YYYY-mm-dd, which checks
* only distribution of number elements.
* <p>
- * For checking if supplied string is real date, use {@link SimpleDateFormatUtil}
- * instead.
+ * For checking if supplied string is real date, use
+ * {@link SimpleDateFormatUtil} instead.
*
*/
public static final Pattern REVISION_PATTERN = Pattern.compile("\\d\\d\\d\\d-\\d\\d-\\d\\d");
- private static final ObjectCache CACHE = ObjectCacheFactory.getObjectCache(SourceIdentifier.class);
+ private static final Interner<SourceIdentifier> INTERNER = Interners.newWeakInterner();
+
private static final long serialVersionUID = 1L;
private final String revision;
private final String name;
/**
*
* Creates new YANG Schema source identifier for sources without revision.
- * {@link SourceIdentifier#NOT_PRESENT_FORMATTED_REVISION} as default revision.
+ * {@link SourceIdentifier#NOT_PRESENT_FORMATTED_REVISION} as default
+ * revision.
*
- * @param name Name of schema
+ * @param name
+ * Name of schema
*/
- public SourceIdentifier(final String name) {
+ SourceIdentifier(final String name) {
this(name, NOT_PRESENT_FORMATTED_REVISION);
}
/**
* Creates new YANG Schema source identifier.
*
- * @param name Name of schema
- * @param formattedRevision Revision of source in format YYYY-mm-dd
+ * @param name
+ * Name of schema
+ * @param formattedRevision
+ * Revision of source in format YYYY-mm-dd
*/
- public SourceIdentifier(final String name, final String formattedRevision) {
+ SourceIdentifier(final String name, final String formattedRevision) {
this.name = Preconditions.checkNotNull(name);
this.revision = Preconditions.checkNotNull(formattedRevision);
}
*
* Creates new YANG Schema source identifier.
*
- * @param name Name of schema
- * @param formattedRevision Revision of source in format YYYY-mm-dd. If not present, default value will be used.
+ * @param name
+ * Name of schema
+ * @param formattedRevision
+ * Revision of source in format YYYY-mm-dd. If not present,
+ * default value will be used.
*/
- public SourceIdentifier(final String name, final Optional<String> formattedRevision) {
+ SourceIdentifier(final String name, final Optional<String> formattedRevision) {
this(name, formattedRevision.or(NOT_PRESENT_FORMATTED_REVISION));
}
/**
- * Return a cached reference to an object equal to this object.
+ * Return an interned reference to a equivalent SemVerSourceIdentifier.
*
- * @return A potentially shared reference, not guaranteed to be unique.
+ * @return Interned reference, or this object if it was interned.
*/
- public SourceIdentifier cachedReference() {
- return CACHE.getReference(this);
+ public SourceIdentifier intern() {
+ return INTERNER.intern(this);
}
/**
return revision;
}
- @Override
- public int hashCode() {
- final int prime = 31;
- int result = 1;
- result = prime * result + ((name == null) ? 0 : name.hashCode());
- result = prime * result + ((revision == null) ? 0 : revision.hashCode());
- return result;
- }
-
- @Override
- public boolean equals(final Object obj) {
- if (this == obj) {
- return true;
- }
- if (obj == null) {
- return false;
- }
- if (getClass() != obj.getClass()) {
- return false;
- }
- SourceIdentifier other = (SourceIdentifier) obj;
- if (name == null) {
- if (other.name != null) {
- return false;
- }
- } else if (!name.equals(other.name)) {
- return false;
- }
- if (revision == null) {
- if (other.revision != null) {
- return false;
- }
- } else if (!revision.equals(other.revision)) {
- return false;
- }
- return true;
- }
-
+ /**
+ * <p>
+ * Since we've got two ways of model versioning (revision & semantic version),
+ * this method shouldn't be called directly anymore. Eventually, callers of this method
+ * should be notified before method gets deleted.
+ * @deprecated use either
+ * <ul>
+ * <li>{@link SemVerSourceIdentifier#create(String, SemVer)}</li>
+ * <li>{@link SemVerSourceIdentifier#create(String, Optional, SemVer)}</li>
+ * <li>{@link SemVerSourceIdentifier#create(String, String, SemVer)}</li>
+ * </ul>
+ * or
+ * <ul>
+ * <li>{@link RevisionSourceIdentifier#create(String)}</li>
+ * <li>{@link RevisionSourceIdentifier#create(String, String)}</li>
+ * <li>{@link RevisionSourceIdentifier#create(String, Optional)}</li>
+ * </ul>
+ *
+ * @param moduleName
+ * Name of schema
+
+ * @param revision
+ * Revision of source in format YYYY-mm-dd. If not present,
+ * default value will be used.
+ *
+ * @return particular SourceIdentifier instance
+ *
+ */
+ @Deprecated
public static SourceIdentifier create(final String moduleName, final Optional<String> revision) {
- return new SourceIdentifier(moduleName, revision);
+ return new RevisionSourceIdentifier(moduleName, revision);
}
/**
* Returns filename for this YANG module as specified in RFC 6020.
*
- * Returns filename in format
- * <code>name ['@' revision] '.yang'</code>
+ * Returns filename in format <code>name ['@' revision] '.yang'</code>
* <p>
- * Where revision is date in format YYYY-mm-dd.
+ * Where revision is date in format YYYY-mm-dd.
* <p>
*
* @see <a href="http://tools.ietf.org/html/rfc6020#section-5.2">RFC6020</a>
return toYangFileName(name, Optional.fromNullable(revision));
}
- @Override
- public String toString() {
- return "SourceIdentifier [name=" + name + "@" + revision + "]";
- }
-
/**
* Returns filename for this YANG module as specified in RFC 6020.
*
- * Returns filename in format
- * <code>moduleName ['@' revision] '.yang'</code>
+ * Returns filename in format <code>moduleName ['@' revision] '.yang'</code>
*
* Where Where revision-date is in format YYYY-mm-dd.
*
* <p>
- * See
- * http://tools.ietf.org/html/rfc6020#section-5.2
+ * See http://tools.ietf.org/html/rfc6020#section-5.2
*
* @return Filename for this source identifier.
*/
- public static final String toYangFileName(final String moduleName, final Optional<String> revision) {
+ public static String toYangFileName(final String moduleName, final Optional<String> revision) {
StringBuilder filename = new StringBuilder(moduleName);
if (revision.isPresent()) {
filename.append('@');
filename.append(".yang");
return filename.toString();
}
-
}
Code Review / yangtools.git / blobdiff