* same local name, but from different schemas.
*
* <ul>
- * <li><b>XMLNamespace</b> - the namespace assigned to the YANG module which
+ * <li><b>XMLNamespace</b> - {@link #getNamespace()} - the namespace assigned to the YANG module which
* defined element, type, procedure or notification.</li>
- * <li><b>Revision</b> - the revision of the YANG module which describes the
+ * <li><b>Revision</b> - {@link #getRevision()} - the revision of the YANG module which describes the
* element</li>
- * <li><b>LocalName</b> - the YANG schema identifier which were defined for this
+ * <li><b>LocalName</b> - {@link #getLocalName()} - the YANG schema identifier which were defined for this
* node in the YANG module</li>
* </ul>
*
+ * QName may also have <code>prefix</code> assigned, but prefix does not
+ * affect equality and identity of two QNames and carry only information
+ * which may be useful for serializers / deserializers.
+ *
*
*/
public final class QName implements Immutable, Serializable, Comparable<QName> {
static final String QNAME_LEFT_PARENTHESIS = "(";
static final String QNAME_RIGHT_PARENTHESIS = ")";
- private static final Pattern QNAME_PATTERN_FULL = Pattern.compile(
- "^\\((.+)\\" + QNAME_REVISION_DELIMITER + "(.+)\\)(.+)$");
- private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile(
- "^\\((.+)\\)(.+)$");
- private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION = Pattern.compile(
- "^(.+)$");
+ private static final Pattern QNAME_PATTERN_FULL = Pattern.compile("^\\((.+)\\" + QNAME_REVISION_DELIMITER
+ + "(.+)\\)(.+)$");
+ private static final Pattern QNAME_PATTERN_NO_REVISION = Pattern.compile("^\\((.+)\\)(.+)$");
+ private static final Pattern QNAME_PATTERN_NO_NAMESPACE_NO_REVISION = Pattern.compile("^(.+)$");
- private static final char[] ILLEGAL_CHARACTERS = new char[] {'?', '(', ')', '&'};
+ private static final char[] ILLEGAL_CHARACTERS = new char[] { '?', '(', ')', '&' };
- //Mandatory
+ // Mandatory
private final QNameModule module;
- //Mandatory
+ // Mandatory
private final String localName;
- //Nullable
+ // Nullable
private final String prefix;
+ private QName(final QNameModule module, final String prefix, final String localName) {
+ this.localName = checkLocalName(localName);
+ this.prefix = prefix;
+ this.module = module;
+ }
+
/**
* QName Constructor.
*
* locally defined prefix assigned to local name
* @param localName
* YANG schema identifier
+ *
*/
public QName(final URI namespace, final Date revision, final String prefix, final String localName) {
- this.localName = checkLocalName(localName);
- this.prefix = prefix;
- this.module = QNameModule.create(namespace, revision);
+ this(QNameModule.create(namespace, revision), prefix, localName);
}
/**
throw new IllegalArgumentException("Parameter 'localName' must be a non-empty string.");
}
- for (char c: ILLEGAL_CHARACTERS) {
+ for (char c : ILLEGAL_CHARACTERS) {
if (localName.indexOf(c) != -1) {
throw new IllegalArgumentException(String.format(
- "Parameter 'localName':'%s' contains illegal character '%s'",
- localName, c));
+ "Parameter 'localName':'%s' contains illegal character '%s'", localName, c));
}
}
return localName;
* the revision of the YANG module
* @param localName
* YANG schema identifier
+ *
+ * @deprecated Use {@link #create(URI, Date, String)} instead.
*/
+ @Deprecated
public QName(final URI namespace, final Date revision, final String localName) {
- this(namespace, revision, null, localName);
+ this(QNameModule.create(namespace, revision), null, localName);
}
+ /**
+ * Construct new QName which reuses namespace, revision and prefix from
+ * base.
+ *
+ * @param base
+ * @param localName
+ * @deprecated Use {@link #create(QName, String)} instead.
+ */
+ @Deprecated
public QName(final QName base, final String localName) {
this(base.getNamespace(), base.getRevision(), base.getPrefix(), localName);
}
/**
- * @deprecated Use {@link #create(String)} instead.
- * This implementation is broken.
+ * @deprecated Use {@link #create(String)} instead. This implementation is
+ * broken.
*/
@Deprecated
public QName(final String input) throws ParseException {
matcher = QNAME_PATTERN_NO_NAMESPACE_NO_REVISION.matcher(input);
if (matcher.matches()) {
String localName = matcher.group(1);
- return new QName((URI)null, localName);
+ return new QName((URI) null, localName);
}
throw new IllegalArgumentException("Invalid input:" + input);
}
return result;
}
+ /**
+ *
+ * Compares the specified object with this list for equality. Returns
+ * <tt>true</tt> if and only if the specified object is also instance of
+ * {@link QName} and its {@link #getLocalName()}, {@link #getNamespace()} and
+ * {@link #getRevision()} are equals to same properties of this instance.
+ *
+ * @param o the object to be compared for equality with this QName
+ * @return <tt>true</tt> if the specified object is equal to this QName
+ *
+ */
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
- public static QName create(final QName base, final String localName){
+ public static QName create(final QName base, final String localName) {
return new QName(base, localName);
}
- public static QName create(final URI namespace, final Date revision, final String localName){
- return new QName(namespace, revision, localName);
+ /**
+ *
+ * Creates new QName.
+ *
+ * @param namespace Namespace of QName or null if namespace is undefined.
+ * @param revision Revision of namespace or null if revision is unspecified.
+ * @param localName Local name part of QName. MUST NOT BE null.
+ * @return Instance of QName
+ */
+ public static QName create(final URI namespace, final Date revision, final String localName) {
+ return new QName(QNameModule.create(namespace, revision), null,localName);
}
-
- public static QName create(final String namespace, final String revision, final String localName) throws IllegalArgumentException{
+ /**
+ *
+ * Creates new QName.
+ *
+ * @param namespace
+ * Namespace of QName, MUST NOT BE Null.
+ * @param revision
+ * Revision of namespace / YANG module. MUST NOT BE null, MUST BE
+ * in format <code>YYYY-mm-dd</code>.
+ * @param localName
+ * Local name part of QName. MUST NOT BE null.
+ * @return
+ * @throws NullPointerException
+ * If any of paramaters is null.
+ * @throws IllegalArgumentException
+ * If <code>namespace</code> is not valid URI or
+ * <code>revision</code> is not according to format
+ * <code>YYYY-mm-dd</code>.
+ */
+ public static QName create(final String namespace, final String revision, final String localName)
+ throws IllegalArgumentException {
final URI namespaceUri;
try {
namespaceUri = new URI(namespace);
- } catch (URISyntaxException ue) {
+ } catch (URISyntaxException ue) {
throw new IllegalArgumentException(String.format("Namespace '%s' is not a valid URI", namespace), ue);
}
return sb.toString();
}
+ /**
+ * Return string representation of revision in format
+ * <code>YYYY-mm-dd</code>
+ *
+ * YANG Specification defines format for <code>revision</code> as
+ * YYYY-mm-dd. This format for revision is reused accross multiple places
+ * such as capabilities URI, YANG modules, etc.
+ *
+ * @return String representation of revision or null, if revision is not
+ * set.
+ */
public String getFormattedRevision() {
return module.getFormattedRevision();
}
+ /**
+ * Creates copy of this with revision and prefix unset.
+ *
+ * @return copy of this QName with revision and prefix unset.
+ */
public QName withoutRevision() {
return QName.create(getNamespace(), null, localName);
}
public static Date parseRevision(final String formatedDate) {
try {
return getRevisionFormat().parse(formatedDate);
- } catch (ParseException| RuntimeException e) {
- throw new IllegalArgumentException(String.format("Revision '%s'is not in a supported format", formatedDate), e);
+ } catch (ParseException | RuntimeException e) {
+ throw new IllegalArgumentException(
+ String.format("Revision '%s'is not in a supported format", formatedDate), e);
}
}
+ /**
+ * Formats {@link Date} representing revision to format
+ * <code>YYYY-mm-dd</code>
+ *
+ * YANG Specification defines format for <code>revision</code> as
+ * YYYY-mm-dd. This format for revision is reused accross multiple places
+ * such as capabilities URI, YANG modules, etc.
+ *
+ * @param revision
+ * Date object to format or null
+ * @return String representation or null if the input was null.
+ */
public static String formattedRevision(final Date revision) {
- if(revision == null) {
+ if (revision == null) {
return null;
}
return getRevisionFormat().format(revision);
}
+ /**
+ *
+ * Compares this QName to other, without comparing revision.
+ *
+ * Compares instance of this to other instance of QName and returns true if
+ * both instances have equal <code>localName</code> ({@link #getLocalName()}
+ * ) and <code>namespace</code> ({@link #getNamespace()}).
+ *
+ * @param other
+ * Other QName. Must not be null.
+ * @return true if this instance and other have equals localName and
+ * namespace.
+ * @throws NullPointerException
+ * if <code>other</code> is null.
+ */
public boolean isEqualWithoutRevision(final QName other) {
return localName.equals(other.getLocalName()) && Objects.equals(getNamespace(), other.getNamespace());
}
*/
package org.opendaylight.yangtools.yang.common;
+/**
+ *
+ * Representation of Error in YANG enabled system.
+ *
+ * Which may be send / received by YANG modeled / enabled systems.
+ *
+ */
public interface RpcError {
+
+ /**
+ *
+ * Returns error severity, as determined by component reporting the error.
+ *
+ * @return error severity
+ */
ErrorSeverity getSeverity();
+ /**
+ *
+ * Returns a string identifying the error condition.
+ *
+ * @return string identifying the error condition.
+ */
String getTag();
+ /**
+ *
+ * Returns a string identifying the data-model-specific or
+ * implementation-specific error condition, if one exists. This element will
+ * not be present if no appropriate application error-tag can be associated
+ * with a particular error condition. If a data-model-specific and an
+ * implementation-specific error-app-tag both exist, then the
+ * data-model-specific value MUST be used by the reporter.
+ *
+ * @return Returns a string identifying the data-model-specific or
+ * implementation-specific error condition, or null if does not
+ * exists.
+ */
String getApplicationTag();
+ /**
+ *
+ * Returns a string suitable for human display that describes the error
+ * condition. This element will not be present if no appropriate message is
+ * provided for a particular error condition.
+ *
+ * @return returns an error description for human display.
+ */
String getMessage();
+ /**
+ *
+ * Contains protocol- or data-model-specific error content. This value may
+ * be not be present if no such error content is provided for a particular
+ * error condition.
+ *
+ * The list in Appendix A defines any mandatory error-info content for each
+ * error. After any protocol-mandated content, a data model definition MAY
+ * mandate that certain application-layer error information be included in
+ * the error-info container.
+ *
+ * An implementation MAY include additional information to provide extended
+ * and/or implementation- specific debugging information.
+ *
+ * @return
+ */
String getInfo();
-
+
+ /**
+ *
+ * Return a cause if available.
+ *
+ * @return cause of this error, if error was triggered by exception.
+ */
Throwable getCause();
-
+
+ /**
+ * Returns the conceptual layer that on which the error occurred.
+ *
+ * @return the conceptual layer that on which the error occurred.
+ */
ErrorType getErrorType();
public enum ErrorSeverity {
Code Review / yangtools.git / commitdiff