Add documentation to Profile class

This commit is contained in:
Paul Schaub 2023-04-17 13:39:36 +02:00
parent 5d2f87eb80
commit 67292864b3
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

View file

@ -4,6 +4,8 @@
package sop;
import java.nio.charset.Charset;
/**
* Tuple class bundling a profile name and description.
*
@ -15,20 +17,66 @@ public class Profile {
private final String name;
private final String description;
/**
* Create a new {@link Profile} object.
* The {@link #toString()} representation MUST NOT exceed a length of 1000 bytes.
*
* @param name profile name
* @param description profile description
*/
public Profile(String name, String description) {
this.name = name;
this.description = description;
if (exceeds1000CharLineLimit(this)) {
throw new IllegalArgumentException("The line representation of a profile MUST NOT exceed 1000 bytes.");
}
}
/**
* Return the name (also known as identifier) of the profile.
* A profile name is a UTF-8 string that has no whitespace in it.
* Similar to OpenPGP Notation names, profile names are divided into two namespaces:
* The IETF namespace and the user namespace.
* A profile name in the user namespace ends with the <pre>@</pre> character (0x40) followed by a DNS domain name.
* A profile name in the IETF namespace does not have an <pre>@</pre> character.
* A profile name in the user space is owned and controlled by the owner of the domain in the suffix.
* A profile name in the IETF namespace that begins with the string <pre>rfc</pre> should have semantics that hew as
* closely as possible to the referenced RFC.
* Similarly, a profile name in the IETF namespace that begins with the string <pre>draft-</pre> should have
* semantics that hew as closely as possible to the referenced Internet Draft.
*
* @return name
*/
public String getName() {
return name;
}
/**
* Return a free-form description of the profile.
*
* @return description
*/
public String getDescription() {
return description;
}
/**
* Convert the profile into a String for displaying.
*
* @return string
*/
public String toString() {
return getName() + ": " + getDescription();
}
/**
* Test if the string representation of the profile exceeds the limit of 1000 bytes length.
* @param profile profile
* @return <pre>true</pre> if the profile exceeds 1000 bytes, <pre>false</pre> otherwise.
*/
private static boolean exceeds1000CharLineLimit(Profile profile) {
String line = profile.toString();
return line.getBytes(Charset.forName("UTF8")).length > 1000;
}
}