de.weltraumschaf.speakingurl

Class SlugImplementation

java.lang.Object

de.weltraumschaf.speakingurl.SlugImplementation

All Implemented Interfaces:

Slug

final class SlugImplementation
extends Object
implements Slug

Implementation of slug.

Author:

Sascha Droste , Sven Strittmatter

Nested Class Summary

Nested classes/interfaces inherited from interface de.weltraumschaf.speakingurl.Slug

Slug.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private static Pattern	ALPHA_NUMERIC Matches alpha numeric characters.
private CharacterMappper	characterMapper Maps general characters.
private static String	MARK Punctuation characters.
private Options	options Holds the slugger options.
private static Pattern	TITLE Matches each word for titles.
private static String	URIC_SLASH URI characters with slash.
private static String	URIC_WITHOUT_SLASH URI characters without slash.
private Validator	validator Validates input.

Constructor Summary

Constructors

Constructor and Description
SlugImplementation() Creates slugger with default options.
SlugImplementation(Options options) Dedicated constructor.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) String	cleanupReplacements(String input, String separator) Cleans the resulting slug from duplicate separators and such.
(package private) String	currentCharacter(String input, int position) Returns character at a given position from a string.
(package private) String	generateAllowedCharatcers(String separator) Generates a string containing all allowed characters.
String	get(String input) Generates a slug from given input string.
String	get(String rawInput, String separator) Generates a slug from given input string with custom separator.
Map<String,String>	getCustom() Get the custom mapping option.
Language	lang() Get the language option.
boolean	maintainCase() Get the maintain case option.
boolean	mark() Get the mark option.
private String	processByCharacters(String input, String separator, String allowedChars) Processes each character of the input string.
(package private) String	replaceCharacters(String ch, boolean lastCharWasSymbol) Replace characters.
(package private) String	replaceDuplicateSeparators(String input, String separator) Removes duplicate separators.
(package private) String	replaceLanguageCharacters(boolean lastCharWasSymbol, String ch) Replace language depending characters.
(package private) String	replaceLeadingAndTrailingSeparator(String input, String separator) Removes leading and trailing separators.
(package private) String	replaceNotAllowedCharacters(String ch, String allowedChars, String separator) Replace all not allowed characters.
(package private) String	replaceSymbols(String ch, boolean lastCharWasSymbol, String result, String separator, String input, int currentPos) Replace symbol characters.
(package private) String	replaceWhitespaces(String input, String separator) Replace all whitespaces with separators.
String	separator() Get the separator option.
boolean	titleCase() Get the title case option.
Set<String>	titleCaseExclude() Get the title case excludes option.
(package private) String	transformCase(String input, Map<String,String> exclusiions) Make each word which starts with alphanumeric character to upper case, except them in the replacement mapCharacter.
int	truncate() Get the truncate length option.
(package private) String	ucfirst(String input) Makes the first character upper case.
boolean	uric() Get the URI characters option.
boolean	uricNoSlash() Get the URI characters without slash option.

Methods inherited from class java.lang.Object

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

Field Detail

URIC_WITHOUT_SLASH

private static final String URIC_WITHOUT_SLASH

URI characters without slash.

See Also:

Constant Field Values

URIC_SLASH

private static final String URIC_SLASH

URI characters with slash.

See Also:

Constant Field Values

MARK

private static final String MARK

Punctuation characters.

See Also:

Constant Field Values

ALPHA_NUMERIC

private static final Pattern ALPHA_NUMERIC

Matches alpha numeric characters.

TITLE

private static final Pattern TITLE

Matches each word for titles.

validator

private final Validator validator

Validates input.

characterMapper

private final CharacterMappper characterMapper

Maps general characters.

options

private final Options options

Holds the slugger options.

Constructor Detail

SlugImplementation

SlugImplementation()

Creates slugger with default options.

SlugImplementation

SlugImplementation(Options options)

Dedicated constructor.

Parameters:

options - must not be null

Method Detail

separator

public String separator()

Description copied from interface: Slug

Get the separator option.

Specified by:

separator in interface Slug

Returns:

never null

lang

public Language lang()

Description copied from interface: Slug

Get the language option.

Specified by:

lang in interface Slug

Returns:

never null

maintainCase

public boolean maintainCase()

Description copied from interface: Slug

Get the maintain case option.

Specified by:

maintainCase in interface Slug

Returns:

whether the option is enabled

titleCase

public boolean titleCase()

Description copied from interface: Slug

Get the title case option.

Specified by:

titleCase in interface Slug

Returns:

whether the option is enabled

titleCaseExclude

public Set<String> titleCaseExclude()

Description copied from interface: Slug

Get the title case excludes option.

Specified by:

titleCaseExclude in interface Slug

Returns:

never null

truncate

public int truncate()

Description copied from interface: Slug

Get the truncate length option.

Specified by:

truncate in interface Slug

Returns:

not negative

uric

public boolean uric()

Description copied from interface: Slug

Get the URI characters option.

Specified by:

uric in interface Slug

Returns:

whether the option is enabled

uricNoSlash

public boolean uricNoSlash()

Description copied from interface: Slug

Get the URI characters without slash option.

Specified by:

uricNoSlash in interface Slug

Returns:

whether the option is enabled

mark

public boolean mark()

Description copied from interface: Slug

Get the mark option.

Specified by:

mark in interface Slug

Returns:

whether the option is enabled

getCustom

public Map<String,String> getCustom()

Description copied from interface: Slug

Get the custom mapping option.

Specified by:

getCustom in interface Slug

Returns:

never null

get

public String get(String input)

Description copied from interface: Slug

Generates a slug from given input string.

Specified by:

get in interface Slug

Parameters:

input - may be null or empty

Returns:

never null, may be empty

get

public String get(String rawInput,
         String separator)

Description copied from interface: Slug

Generates a slug from given input string with custom separator.

This method overwrites the separator configured by Slug.Builder.separator(java.lang.String).

Specified by:

get in interface Slug

Parameters:

rawInput - may be null or empty

separator - must not be null

Returns:

never null, may be empty

processByCharacters

private String processByCharacters(String input,
                         String separator,
                         String allowedChars)

Processes each character of the input string.

Parameters:

input - must not be null

separator - must not be null or empty

allowedChars - must not be null

Returns:

never null

generateAllowedCharatcers

String generateAllowedCharatcers(String separator)

Generates a string containing all allowed characters.

Parameters:

separator - must not be null or empty

Returns:

never null

currentCharacter

String currentCharacter(String input,
                      int position)

Returns character at a given position from a string.

Parameters:

input - string to get character from

position - the obtained position

Returns:

never null

replaceSymbols

String replaceSymbols(String ch,
                    boolean lastCharWasSymbol,
                    String result,
                    String separator,
                    String input,
                    int currentPos)

Replace symbol characters.

Parameters:

ch - the current character to replace

lastCharWasSymbol - whether the last character was a symbol

result - the current result

separator - must not be null or empty

input - the preprocessed input string

currentPos - the current position in the input string

Returns:

never null

replaceCharacters

String replaceCharacters(String ch,
                       boolean lastCharWasSymbol)

Replace characters.

Parameters:

ch - the current character to replace

lastCharWasSymbol - whether the last character was a symbol

Returns:

never null

replaceLanguageCharacters

String replaceLanguageCharacters(boolean lastCharWasSymbol,
                               String ch)

Replace language depending characters.

Parameters:

lastCharWasSymbol - whether the last character was a symbol

ch - the current character to replace

Returns:

never null

replaceNotAllowedCharacters

String replaceNotAllowedCharacters(String ch,
                                 String allowedChars,
                                 String separator)

Replace all not allowed characters.

Parameters:

ch - the current character to replace

allowedChars - string containing all allowed characters

separator - must not be null or empty

Returns:

never null

cleanupReplacements

String cleanupReplacements(String input,
                         String separator)

Cleans the resulting slug from duplicate separators and such.

Parameters:

input - will be cleaned

separator - must not be null or empty

Returns:

never null

replaceWhitespaces

String replaceWhitespaces(String input,
                        String separator)

Replace all whitespaces with separators.

Parameters:

input - will be processed

separator - must not be null or empty

Returns:

never null

replaceDuplicateSeparators

String replaceDuplicateSeparators(String input,
                                String separator)

Removes duplicate separators.

Parameters:

input - will be processed

separator - must not be null or empty

Returns:

never null

replaceLeadingAndTrailingSeparator

String replaceLeadingAndTrailingSeparator(String input,
                                        String separator)

Removes leading and trailing separators.

Parameters:

input - will be processed

separator - must not be null or empty

Returns:

never null

transformCase

String transformCase(String input,
                   Map<String,String> exclusiions)

Make each word which starts with alphanumeric character to upper case, except them in the replacement mapCharacter.

Parameters:

input - may be null or empty

exclusiions - mapCharacter with key and value same

Returns:

never null, may be empty

ucfirst

String ucfirst(String input)

Makes the first character upper case.

Parameters:

input - may be null or empty

Returns:

never null, may be empty