This adds a bit of documentation and correcting a mitsaken @return.
Change-Id: I56ed5aa57969fad5230c8b3a30503f162888ee22
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
- * Read an UnboundQName from a DataInput. The format is expected to match the output format of
+ * Read an QualifiedQName from a DataInput. The format is expected to match the output format of
* {@link #writeTo(DataOutput)}.
*
* @param in DataInput to read
* {@link #writeTo(DataOutput)}.
*
* @param in DataInput to read
- * @return An UnboundQName instance
+ * @return An QualifiedQName instance
* @throws IOException if I/O error occurs
*/
public static QualifiedQName readFrom(final DataInput in) throws IOException {
* @throws IOException if I/O error occurs
*/
public static QualifiedQName readFrom(final DataInput in) throws IOException {
+ /**
+ * Create a new unqualified QName.
+ *
+ * @param localName The local name of this unqualified QName
+ * @return An UnqualifiedQName instance
+ * @throws IllegalArgumentException if localName is null or it does not conform to YANG localName requirements.
+ */
public static UnqualifiedQName of(final String localName) {
return new UnqualifiedQName(checkLocalName(localName));
}
/**
public static UnqualifiedQName of(final String localName) {
return new UnqualifiedQName(checkLocalName(localName));
}
/**
- * Read an UnboundQName from a DataInput. The format is expected to match the output format of
+ * Read an UnqualifiedQName from a DataInput. The format is expected to match the output format of
* {@link #writeTo(DataOutput)}.
*
* @param in DataInput to read
* {@link #writeTo(DataOutput)}.
*
* @param in DataInput to read
- * @return An UnboundQName instance
+ * @return An UnqualifiedQName instance
* @throws IOException if I/O error occurs
*/
public static UnqualifiedQName readFrom(final DataInput in) throws IOException {
* @throws IOException if I/O error occurs
*/
public static UnqualifiedQName readFrom(final DataInput in) throws IOException {