rocks.xmpp.precis

Class PrecisProfile

java.lang.Object

rocks.xmpp.precis.PrecisProfile

All Implemented Interfaces:

Comparator<CharSequence>

public abstract class PrecisProfile
extends Object
implements Comparator<CharSequence>

This is the base class for a PRECIS profile. A profile defines a set of rules (width mapping, additional mapping, case mapping, normalization and directionality) and uses one of two string classes, IdentifierClass or FreeformClass, which define the allowed and disallowed characters.

There are three basic use cases you can do with this class:

• Preparation: entails only ensuring that the characters in an individual string are allowed by the underlying PRECIS string class.
• Enforcement: entails applying all of the rules specified for a particular string class or profile thereof to an individual string, for the purpose of determining if the string can be used in a given protocol slot.
• Comparison: entails applying all of the rules specified for a particular string class or profile thereof to two separate strings, for the purpose of determining if the two strings are equivalent.

See Also:

4. String Classes, 5. Profiles, PrecisProfiles

Method Summary

Modifier and Type	Method and Description
int	compare(CharSequence o1, CharSequence o2) Compares two strings with each other.
String	enforce(CharSequence input) Enforcement entails applying all of the rules specified for a particular string class or profile thereof to an individual string, for the purpose of determining if the string can be used in a given protocol slot.
String	prepare(CharSequence input) Preparation entails only ensuring that the characters in an individual string are allowed by the underlying PRECIS string class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Method Detail

prepare

public String prepare(CharSequence input)

Preparation entails only ensuring that the characters in an individual string are allowed by the underlying PRECIS string class.

Parameters:

input - The input string.

Returns:

For convenience, returns the same string as the input string.

Throws:

InvalidCodePointException - If the input contains invalid code points (which are disallowed by the underlying Precis String class).

enforce

public String enforce(CharSequence input)

Enforcement entails applying all of the rules specified for a particular string class or profile thereof to an individual string, for the purpose of determining if the string can be used in a given protocol slot.

This base method first applies the profile rules, then the behavioral rules as per RFC 7564 §7.

Parameters:

input - The input string.

Returns:

The output string.

Throws:

InvalidCodePointException - If the input contains invalid code points (which are disallowed by the underlying Precis String class).

See Also:

7. Order of Operations

compare

public int compare(CharSequence o1,
                   CharSequence o2)

Compares two strings with each other. The default comparison method enforces the rules of a profile to each string and then compares them. However, there are exceptions to this approach, like in the Nickname profile, where comparison uses different rules than enforcement.

Specified by:

compare in interface Comparator<CharSequence>

Parameters:

o1 - The first string.

o2 - The second string.

Returns:

0 if the strings are equal, otherwise the comparison result.

Throws:

InvalidCodePointException - If the input contains invalid code points (which are disallowed by the underlying Precis String class).