Java tutorial
/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.onos.yangtools.yang.model.repo.api; import com.google.common.annotations.Beta; import com.google.common.base.Optional; import com.google.common.base.Preconditions; import java.util.regex.Pattern; import org.onos.yangtools.concepts.Identifier; import org.onos.yangtools.concepts.Immutable; import org.onos.yangtools.objcache.ObjectCache; import org.onos.yangtools.objcache.ObjectCacheFactory; import org.onos.yangtools.yang.common.SimpleDateFormatUtil; /** * YANG Schema source identifier * * 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 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 ). */ @Beta public final class SourceIdentifier implements Identifier, Immutable { /** * 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. * */ 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 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. * * @param name Name of schema */ public 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 */ public 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. */ public 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 A potentially shared reference, not guaranteed to be unique. */ public SourceIdentifier cachedReference() { return CACHE.getReference(this); } /** * Returns model name * * @return model name */ public String getName() { return name; } /** * Returns revision of source or null if revision was not supplied. * * @return revision of source or null if revision was not supplied. */ public String getRevision() { 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; } public static SourceIdentifier create(final String moduleName, final Optional<String> revision) { return new SourceIdentifier(moduleName, revision); } /** * Returns filename for this YANG module as specified in RFC 6020. * * Returns filename in format * <code>name ['@' revision] '.yang'</code> * <p> * 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 Filename for this source identifier. */ public String toYangFilename() { 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> * * Where Where revision-date is in format YYYY-mm-dd. * * <p> * 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) { StringBuilder filename = new StringBuilder(moduleName); if (revision.isPresent()) { filename.append('@'); filename.append(revision.get()); } filename.append(".yang"); return filename.toString(); } }