Stringprep (RFC 3454) 2.0 · com.ongres.stringprep.Stringprep

Field Summary

Modifier and Type	Field and Description
private final boolean	additionalMapping
private final boolean	caseFoldNfkc
private final boolean	caseFoldNoNormalization
private final boolean	checkBidi
private final boolean	forbidAdditionalCharacters
private final boolean	forbidAsciiControl
private final boolean	forbidAsciiSpaces
private final boolean	forbidChangeDisplayDeprecated
private final boolean	forbidInappropriateCanonRep
private final boolean	forbidInappropriatePlainText
private final boolean	forbidNonAsciiControl
private final boolean	forbidNonAsciiSpaces
private final boolean	forbidNonCharacter
private final boolean	forbidPrivateUse
private final boolean	forbidSurrogate
private final boolean	forbidTagging
private final boolean	forbidUnassigned
private final boolean	mapToNothing
private final boolean	normalizeKc
private final Profile	profile

Constructor Summary

Access	Constructor and Description
pack-priv	Stringprep(Profile includes the options to implement a Stringprep profile. profile, boolean "stored strings" MUST NOT contain unassigned code points, "queries" MAY include them. storedStrings) Create a Stringprep instance based on a `Profile` `Option`s and the two different types of strings in typical protocols where internationalized strings are used: "stored strings" and "queries".

Method Summary

Modifier and Type	Method and Description
public static Profile	Returns: Profile if there is a provider match. getProvider(String name of the profile to lookup from the ServiceLoader. profileName) Lookup the provider service that contains the profile.
private String	map(String string)
pack-priv String	Returns: The prepared string following the options of the profile. prepare(String to prepare. string) Preparation of Internationalized Strings.
private static IllegalArgumentException	prohibitedCharater(String msg, int cp)
private void	prohibitedOutput(int codePoint)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

additionalMapping	back to summary
private final boolean additionalMapping

caseFoldNfkc	back to summary
private final boolean caseFoldNfkc

caseFoldNoNormalization	back to summary
private final boolean caseFoldNoNormalization

checkBidi	back to summary
private final boolean checkBidi

forbidAdditionalCharacters	back to summary
private final boolean forbidAdditionalCharacters

forbidAsciiControl	back to summary
private final boolean forbidAsciiControl

forbidAsciiSpaces	back to summary
private final boolean forbidAsciiSpaces

forbidChangeDisplayDeprecated	back to summary
private final boolean forbidChangeDisplayDeprecated

forbidInappropriateCanonRep	back to summary
private final boolean forbidInappropriateCanonRep

forbidInappropriatePlainText	back to summary
private final boolean forbidInappropriatePlainText

forbidNonAsciiControl	back to summary
private final boolean forbidNonAsciiControl

forbidNonAsciiSpaces	back to summary
private final boolean forbidNonAsciiSpaces

forbidNonCharacter	back to summary
private final boolean forbidNonCharacter

forbidPrivateUse	back to summary
private final boolean forbidPrivateUse

forbidSurrogate	back to summary
private final boolean forbidSurrogate

forbidTagging	back to summary
private final boolean forbidTagging

forbidUnassigned	back to summary
private final boolean forbidUnassigned

mapToNothing	back to summary
private final boolean mapToNothing

normalizeKc	back to summary
private final boolean normalizeKc

profile	back to summary
private final Profile profile

Constructor Detail

Stringprep back to summary

Stringprep	back to summary
pack-priv Stringprep(Profile profile, boolean storedStrings) Create a Stringprep instance based on a `Profile` `Option`s and the two different types of strings in typical protocols where internationalized strings are used: "stored strings" and "queries". Parameters profile:Profile includes the options to implement a Stringprep profile. storedStrings:boolean "stored strings" MUST NOT contain unassigned code points, "queries" MAY include them. Exceptions NullPointerException: if `profile` is `null`.

pack-priv Stringprep(Profile profile, boolean storedStrings)

Create a Stringprep instance based on a Profile Options and the two different types of strings in typical protocols where internationalized strings are used: "stored strings" and "queries".

Parameters

profile:Profile: includes the options to implement a Stringprep profile.
storedStrings:boolean: "stored strings" MUST NOT contain unassigned code points, "queries" MAY include them.

Exceptions

NullPointerException:: if profile is null.

Method Detail

getProvider back to summary

getProvider	back to summary
public static Profile getProvider(String profileName) Lookup the provider service that contains the profile. Parameters profileName:String name of the profile to lookup from the ServiceLoader. Returns:Profile Profile if there is a provider match. Exceptions IllegalArgumentException: if no provider is found. NullPointerException: if `profileName` is `null`.

public static Profile getProvider(String profileName)

Lookup the provider service that contains the profile.

Parameters

profileName:String: name of the profile to lookup from the ServiceLoader.

Returns:Profile

Profile if there is a provider match.

Exceptions

IllegalArgumentException:: if no provider is found.
NullPointerException:: if profileName is null.

map	back to summary
private String map(String string)

prepare back to summary

prepare	back to summary
pack-priv String prepare(String string) Preparation of Internationalized Strings. The steps for preparing strings are: Map -- For each character in the input, check if it has a mapping and, if so, replace it with its mapping. This is described in section 3. Normalize -- Possibly normalize the result of step 1 using Unicode normalization. This is described in section 4. Prohibit -- Check for any characters that are not allowed in the output. If any are found, return an error. This is described in section 5. Check bidi -- Possibly check for right-to-left characters, and if any are found, make sure that the whole string satisfies the requirements for bidirectional strings. If the string does not satisfy the requirements for bidirectional strings, return an error. This is described in section 6. Parameters string:String to prepare. Returns:String The prepared string following the options of the profile. Exceptions IllegalArgumentException: if there are prohibited or bidi characters depending on the profile used. NullPointerException: if `string` is `null`.

pack-priv String prepare(String string)

Preparation of Internationalized Strings.

The steps for preparing strings are:

Map -- For each character in the input, check if it has a mapping and, if so, replace it with its mapping. This is described in section 3.
Normalize -- Possibly normalize the result of step 1 using Unicode normalization. This is described in section 4.
Prohibit -- Check for any characters that are not allowed in the output. If any are found, return an error. This is described in section 5.
Check bidi -- Possibly check for right-to-left characters, and if any are found, make sure that the whole string satisfies the requirements for bidirectional strings. If the string does not satisfy the requirements for bidirectional strings, return an error. This is described in section 6.

Parameters

string:String: to prepare.

Returns:String

The prepared string following the options of the profile.

Exceptions

IllegalArgumentException:: if there are prohibited or bidi characters depending on the profile used.
NullPointerException:: if string is null.

prohibitedCharater	back to summary
private static IllegalArgumentException prohibitedCharater(String msg, int cp)

prohibitedOutput	back to summary
private void prohibitedOutput(int codePoint)

public final Class Stringprep

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail