yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YangTextSchemaSource.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.model.repo.api;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.yangtools.yang.common.YangConstants.RFC6020_YANG_FILE_EXTENSION;
  13 import static org.opendaylight.yangtools.yang.common.YangNames.parseFilename;
  14
  15 import com.google.common.annotations.Beta;
  16 import com.google.common.base.MoreObjects;
  17 import com.google.common.base.MoreObjects.ToStringHelper;
  18 import com.google.common.io.ByteSource;
  19 import com.google.common.io.Resources;
  20 import java.io.File;
  21 import java.io.InputStream;
  22 import java.net.URL;
  23 import java.nio.file.Files;
  24 import java.nio.file.Path;
  25 import java.util.Map.Entry;
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.opendaylight.yangtools.yang.common.Revision;
  28
  29 /**
  30  * YANG text schema source representation. Exposes an RFC6020 or RFC7950 text representation as an {@link InputStream}.
  31  */
  32 @Beta
  33 public abstract class YangTextSchemaSource extends ByteSource implements YangSchemaSourceRepresentation {
  34     private final @NonNull SourceIdentifier identifier;
  35
  36     protected YangTextSchemaSource(final SourceIdentifier identifier) {
  37         this.identifier = requireNonNull(identifier);
  38     }
  39
  40     public static @NonNull SourceIdentifier identifierFromFilename(final String name) {
  41         checkArgument(name.endsWith(RFC6020_YANG_FILE_EXTENSION), "Filename '%s' does not end with '%s'", name,
  42             RFC6020_YANG_FILE_EXTENSION);
  43
  44         final String baseName = name.substring(0, name.length() - RFC6020_YANG_FILE_EXTENSION.length());
  45         final Entry<String, String> parsed = parseFilename(baseName);
  46         return RevisionSourceIdentifier.create(parsed.getKey(), Revision.ofNullable(parsed.getValue()));
  47     }
  48
  49     /**
  50      * Create a new YangTextSchemaSource with a specific source identifier and backed
  51      * by ByteSource, which provides the actual InputStreams.
  52      *
  53      * @param identifier SourceIdentifier of the resulting schema source
  54      * @param delegate Backing ByteSource instance
  55      * @return A new YangTextSchemaSource
  56      */
  57     public static @NonNull YangTextSchemaSource delegateForByteSource(final SourceIdentifier identifier,
  58             final ByteSource delegate) {
  59         return new DelegatedYangTextSchemaSource(identifier, delegate);
  60     }
  61
  62     /**
  63      * Create a new YangTextSchemaSource with {@link SourceIdentifier} derived from a supplied filename and backed
  64      * by ByteSource, which provides the actual InputStreams.
  65      *
  66      * @param fileName File name
  67      * @param delegate Backing ByteSource instance
  68      * @return A new YangTextSchemaSource
  69      * @throws IllegalArgumentException if the file name has invalid format
  70      */
  71     public static @NonNull YangTextSchemaSource delegateForByteSource(final String fileName,
  72             final ByteSource delegate) {
  73         return new DelegatedYangTextSchemaSource(identifierFromFilename(fileName), delegate);
  74     }
  75
  76     /**
  77      * Create a new YangTextSchemaSource backed by a {@link File} with {@link SourceIdentifier} derived from the file
  78      * name.
  79      *
  80      * @param path Backing path
  81      * @return A new YangTextSchemaSource
  82      * @throws IllegalArgumentException if the file name has invalid format or if the supplied File is not a file
  83      * @throws NullPointerException if file is {@code null}
  84      */
  85     public static @NonNull YangTextSchemaSource forPath(final Path path) {
  86         return forPath(path, identifierFromFilename(path.toFile().getName()));
  87     }
  88
  89     /**
  90      * Create a new YangTextSchemaSource backed by a {@link File} and specified {@link SourceIdentifier}.
  91      *
  92      * @param path Backing path
  93      * @param identifier source identifier
  94      * @return A new YangTextSchemaSource
  95      * @throws NullPointerException if any argument is {@code null}
  96      * @throws IllegalArgumentException if the supplied path is not a regular file
  97      */
  98     public static @NonNull YangTextSchemaSource forPath(final Path path, final SourceIdentifier identifier) {
  99         checkArgument(Files.isRegularFile(path), "Supplied path %s is not a regular file", path);
 100         return new YangTextFileSchemaSource(identifier, path);
 101     }
 102
 103     /**
 104      * Create a new {@link YangTextSchemaSource} backed by a resource available in the ClassLoader where this
 105      * class resides.
 106      *
 107      * @param resourceName Resource name
 108      * @return A new instance.
 109      * @throws IllegalArgumentException if the resource does not exist or if the name has invalid format
 110      */
 111     public static @NonNull YangTextSchemaSource forResource(final String resourceName) {
 112         return forResource(YangTextSchemaSource.class, resourceName);
 113     }
 114
 115     /**
 116      * Create a new {@link YangTextSchemaSource} backed by a resource by a resource available on the ClassLoader
 117      * which loaded the specified class.
 118      *
 119      * @param clazz Class reference
 120      * @param resourceName Resource name
 121      * @return A new instance.
 122      * @throws IllegalArgumentException if the resource does not exist or if the name has invalid format
 123      */
 124     public static @NonNull YangTextSchemaSource forResource(final Class<?> clazz, final String resourceName) {
 125         final String fileName = resourceName.substring(resourceName.lastIndexOf('/') + 1);
 126         final SourceIdentifier identifier = identifierFromFilename(fileName);
 127         final URL url = Resources.getResource(clazz, resourceName);
 128         return new ResourceYangTextSchemaSource(identifier, url);
 129     }
 130
 131     /**
 132      * Create a new {@link YangTextSchemaSource} backed by a URL.
 133      *
 134      * @param url Backing URL
 135      * @param identifier Source identifier
 136      * @return A new instance.
 137      * @throws NullPointerException if any argument is {@code null}
 138      */
 139     public static @NonNull YangTextSchemaSource forURL(final URL url, final SourceIdentifier identifier) {
 140         return new ResourceYangTextSchemaSource(identifier, url);
 141     }
 142
 143     @Override
 144     public final SourceIdentifier getIdentifier() {
 145         return identifier;
 146     }
 147
 148     @Override
 149     public Class<? extends YangTextSchemaSource> getType() {
 150         return YangTextSchemaSource.class;
 151     }
 152
 153     @Override
 154     public final String toString() {
 155         return addToStringAttributes(MoreObjects.toStringHelper(this).add("identifier", identifier)).toString();
 156     }
 157
 158     /**
 159      * Add subclass-specific attributes to the output {@link #toString()} output. Since
 160      * subclasses are prevented from overriding {@link #toString()} for consistency
 161      * reasons, they can add their specific attributes to the resulting string by attaching
 162      * attributes to the supplied {@link ToStringHelper}.
 163      *
 164      * @param toStringHelper ToStringHelper onto the attributes can be added
 165      * @return ToStringHelper supplied as input argument.
 166      */
 167     protected abstract ToStringHelper addToStringAttributes(ToStringHelper toStringHelper);
 168 }