* 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.opendaylight.yangtools.yang.model.repo.api;
+package org.opendaylight.yangtools.yang.model.spi.source;
import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
-import java.util.Optional;
import javax.xml.transform.Source;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.YangConstants;
+import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Attr;
import org.w3c.dom.NodeList;
/**
- * Utility {@link YinXmlSchemaSource} exposing a W3C {@link DOMSource} representation of YIN model.
+ * Utility {@link YinXmlSource} exposing a W3C {@link DOMSource} representation of YIN model.
*/
-public abstract class YinDomSchemaSource implements YinXmlSchemaSource {
- private static final Logger LOG = LoggerFactory.getLogger(YinDomSchemaSource.class);
+public abstract sealed class YinDomSource implements YinXmlSource {
+ private static final Logger LOG = LoggerFactory.getLogger(YinDomSource.class);
private static final TransformerFactory TRANSFORMER_FACTORY = TransformerFactory.newInstance();
private static final QName REVISION_STMT = REVISION.getStatementName();
private static final String MODULE_ARG = MODULE.getArgumentDefinition().orElseThrow()
private static final String REVISION_ARG = REVISION.getArgumentDefinition().orElseThrow()
.argumentName().getLocalName();
- YinDomSchemaSource() {
- // Prevent outside instantiation
- }
-
/**
- * Create a new {@link YinDomSchemaSource} using an identifier and a source.
+ * Create a new {@link YinDomSource} using an identifier and a source.
*
* @param identifier Schema source identifier
* @param source W3C DOM source
* @param symbolicName Source symbolic name
- * @return A new {@link YinDomSchemaSource} instance.
+ * @return A new {@link YinDomSource} instance.
*/
- public static @NonNull YinDomSchemaSource create(final @NonNull SourceIdentifier identifier,
+ public static @NonNull YinDomSource create(final @NonNull SourceIdentifier identifier,
final @NonNull DOMSource source, final @Nullable String symbolicName) {
final Node root = source.getNode().getFirstChild();
final Attr dateAttr = revisionStmt.getAttributeNode(REVISION_ARG);
checkArgument(dateAttr != null, "No revision statement argument found in %s", revisionStmt);
- final SourceIdentifier parsedId = new SourceIdentifier(nameAttr.getValue(), dateAttr.getValue());
+ final var parsedId = new SourceIdentifier(nameAttr.getValue(), dateAttr.getValue());
final SourceIdentifier id;
if (!parsedId.equals(identifier)) {
LOG.debug("Changed identifier from {} to {}", identifier, parsedId);
}
/**
- * Create a {@link YinDomSchemaSource} from a {@link YinXmlSchemaSource}. If the argument is already a
+ * Create a {@link YinDomSource} from a {@link YinXmlSource}. If the argument is already a
* YinDomSchemaSource, this method returns the same instance. The source will be translated on first access,
* at which point an {@link IllegalStateException} may be raised.
*
* @param xmlSchemaSource Backing schema source
- * @return A {@link YinDomSchemaSource} instance
+ * @return A {@link YinDomSource} instance
*/
- public static @NonNull YinDomSchemaSource lazyTransform(final YinXmlSchemaSource xmlSchemaSource) {
- final YinDomSchemaSource cast = castSchemaSource(xmlSchemaSource);
+ public static @NonNull YinDomSource lazyTransform(final YinXmlSource xmlSchemaSource) {
+ final var cast = castSchemaSource(xmlSchemaSource);
return cast != null ? cast : new Transforming(xmlSchemaSource);
}
/**
- * Create a {@link YinDomSchemaSource} from a {@link YinXmlSchemaSource}. If the argument is already a
+ * Create a {@link YinDomSource} from a {@link YinXmlSource}. If the argument is already a
* YinDomSchemaSource, this method returns the same instance. The source will be translated immediately.
*
* @param xmlSchemaSource Backing schema source
- * @return A {@link YinDomSchemaSource} instance
+ * @return A {@link YinDomSource} instance
* @throws TransformerException when the provided source fails to transform
*/
- public static @NonNull YinDomSchemaSource transform(final YinXmlSchemaSource xmlSchemaSource)
+ public static @NonNull YinDomSource transform(final YinXmlSource xmlSchemaSource)
throws TransformerException {
- final YinDomSchemaSource cast = castSchemaSource(xmlSchemaSource);
+ final var cast = castSchemaSource(xmlSchemaSource);
return cast != null ? cast :
- create(xmlSchemaSource.getIdentifier(), transformSource(xmlSchemaSource.getSource()),
- xmlSchemaSource.getSymbolicName().orElse(null));
+ create(xmlSchemaSource.sourceId(), transformSource(xmlSchemaSource.getSource()),
+ xmlSchemaSource.symbolicName());
}
@Override
- public abstract DOMSource getSource();
+ public final Class<YinDomSource> getType() {
+ return YinDomSource.class;
+ }
@Override
- public final Class<YinDomSchemaSource> getType() {
- return YinDomSchemaSource.class;
- }
+ public abstract DOMSource getSource();
@Override
public final String toString() {
- return addToStringAttributes(MoreObjects.toStringHelper(this).add("identifier", getIdentifier())).toString();
+ return addToStringAttributes(MoreObjects.toStringHelper(this).add("sourceId", sourceId())).toString();
}
/**
return new DOMSource(result.getNode(), result.getSystemId());
}
- private static @Nullable YinDomSchemaSource castSchemaSource(final YinXmlSchemaSource xmlSchemaSource) {
- if (xmlSchemaSource instanceof YinDomSchemaSource yinDom) {
+ private static @Nullable YinDomSource castSchemaSource(final YinXmlSource xmlSchemaSource) {
+ if (xmlSchemaSource instanceof YinDomSource yinDom) {
return yinDom;
}
- final Source source = xmlSchemaSource.getSource();
+ final var source = xmlSchemaSource.getSource();
if (source instanceof DOMSource dom) {
- return create(xmlSchemaSource.getIdentifier(), dom, xmlSchemaSource.getSymbolicName().orElse(null));
+ return create(xmlSchemaSource.sourceId(), dom, xmlSchemaSource.symbolicName());
}
return null;
}
- private static final class Simple extends YinDomSchemaSource {
- private final @NonNull SourceIdentifier identifier;
+ private static final class Simple extends YinDomSource {
+ private final @NonNull SourceIdentifier sourceId;
private final @NonNull DOMSource source;
private final String symbolicName;
- Simple(final @NonNull SourceIdentifier identifier, final @NonNull DOMSource source,
+ Simple(final @NonNull SourceIdentifier sourceId, final @NonNull DOMSource source,
final @Nullable String symbolicName) {
- this.identifier = requireNonNull(identifier);
+ this.sourceId = requireNonNull(sourceId);
this.source = requireNonNull(source);
this.symbolicName = symbolicName;
}
@Override
- public DOMSource getSource() {
- return source;
+ public SourceIdentifier sourceId() {
+ return sourceId;
}
@Override
- public SourceIdentifier getIdentifier() {
- return identifier;
+ public DOMSource getSource() {
+ return source;
}
@Override
- public Optional<String> getSymbolicName() {
- return Optional.ofNullable(symbolicName);
+ public String symbolicName() {
+ return symbolicName;
}
@Override
}
}
- private static final class Transforming extends YinDomSchemaSource {
- private final YinXmlSchemaSource xmlSchemaSource;
+ private static final class Transforming extends YinDomSource {
+ private final YinXmlSource xmlSchemaSource;
+
private volatile DOMSource source;
- Transforming(final YinXmlSchemaSource xmlSchemaSource) {
+ Transforming(final YinXmlSource xmlSchemaSource) {
this.xmlSchemaSource = requireNonNull(xmlSchemaSource);
}
+ @Override
+ public SourceIdentifier sourceId() {
+ return xmlSchemaSource.sourceId();
+ }
+
+ @Override
+ public String symbolicName() {
+ return xmlSchemaSource.symbolicName();
+ }
+
@Override
public DOMSource getSource() {
DOMSource ret = source;
return ret;
}
- @Override
- public SourceIdentifier getIdentifier() {
- return xmlSchemaSource.getIdentifier();
- }
-
- @Override
- public Optional<String> getSymbolicName() {
- return xmlSchemaSource.getSymbolicName();
- }
-
@Override
protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
return toStringHelper.add("xmlSchemaSource", xmlSchemaSource);
Code Review / yangtools.git / blobdiff