org.databene.commons.CharSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of databene-commons Show documentation
Show all versions of databene-commons Show documentation
'databene commons' is an open source Java library by Volker Bergmann.
It provides extensions to the Java core library by utility classes, abstract concepts
and concrete implementations.
The newest version!
/*
* Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.databene.commons;
import java.util.Iterator;
import java.util.Set;
import java.util.HashSet;
import java.util.Locale;
/**
* Represents a Set of characters and provides locale-dependent character sets
* as well as set manipulation methods.
* Created: 18.08.2006 19:49:17
* @author Volker Bergmann
*/
public class CharSet implements Named {
private String name;
/** The locale to use for letters */
private Locale locale;
/** the wrapped set */
private Set set;
// constructors ----------------------------------------------------------------------------------------------------
/** Default constructor that initializes to an isEmpty Set of characters with the fallback locale. */
public CharSet() {
this(LocaleUtil.getFallbackLocale());
}
/** Constructor that initializes to an isEmpty Set of characters with the specified locale.
* @param locale the locale for which to create te set */
public CharSet(Locale locale) {
set = new HashSet();
this.locale = locale;
}
/** Constructor that initializes to a Set with one character with the fallback locale.
* @param c the character to include */
public CharSet(char c) {
set = new HashSet();
set.add(Character.valueOf(c));
this.locale = LocaleUtil.getFallbackLocale();
}
public CharSet(char from, char to) {
this(null, from, to);
}
/** Constructor that initializes to a continuous range of characters with the fallback locale.
* @param name the name of the set
* @param from the first character to include
* @param to the last character to include */
public CharSet(String name, char from, char to) {
this.name = name;
set = new HashSet();
for (char c = from; c <= to; c++)
set.add(Character.valueOf(c));
this.locale = LocaleUtil.getFallbackLocale();
}
/** Constructor that initializes to a predefined Set of characters with the fallback locale.
* @param charSet the set of characters to include */
public CharSet(CharSet charSet) {
this(charSet.set);
}
/** Constructor that initializes to a predefined Set of characters with the fallback locale.
* @param set the set of characters to include */
public CharSet(Set set) {
this(null, set);
}
public CharSet(String name, Set set) {
this.name = name;
this.set = new HashSet(set);
this.locale = LocaleUtil.getFallbackLocale();
}
// properties ------------------------------------------------------------------------------------------------------
@Override
public String getName() {
return name;
}
// digit related interface -----------------------------------------------------------------------------------------
public CharSet addDigits() {
return addAll(getDigits());
}
public CharSet removeDigits() {
return removeAll(getDigits());
}
public CharSet addHexDigits() {
return addAll(getHexDigits());
}
public CharSet removeHexDigits() {
return removeAll(getHexDigits());
}
public CharSet addNonDigits() {
return addAll(getNonDigits());
}
public CharSet removeNonDigits() {
return removeAll(getNonDigits());
}
public static Set getDigits() {
return new CharSet('0', '9').getSet();
}
public static Set getHexDigits() {
return new CharSet('0', '9').addRange('a', 'f').addRange('A', 'F').getSet();
}
public static Set getNonDigits() {
return new CharSet().addAnyCharacters().removeAll(getDigits()).getSet();
}
// word related interface ------------------------------------------------------------------------------------------
/** Adds all letters of the internal locale to the Set.
* @return this */
public CharSet addWordChars() {
return addWordChars(locale);
}
/** Adds all letters of the specified locale to the Set.
* @param locale the locale for which to get the cahracters
* @return this */
public CharSet addWordChars(Locale locale) {
return addAll(getWordChars(locale));
}
/** Removes all letters of the internal locale from the Set.
* @return this */
public CharSet removeWordChars() {
return removeWordChars(locale);
}
/** Removes all letters of the specified locale from the Set.
* @param locale the locale for which to get the characters
* @return this */
public CharSet removeWordChars(Locale locale) {
return removeAll(getWordChars(locale));
}
/** Returns all letters of the specified locale.
* @param locale the locale for which to get the characters
* @return a set with all letters of the specified locale */
public static Set getWordChars(Locale locale) {
Set wordChars = LocaleUtil.letters(locale);
wordChars.add('_');
wordChars.addAll(getDigits());
return wordChars;
}
/** Adds all characters that are not letters of any locale.
* @return this */
public CharSet addNonWordChars() {
return addAll(getNonWordChars());
}
/** Removes all characters that are not letters of any locale.
* @return this */
public CharSet removeNonWordChars() {
return removeAll(getNonWordChars());
}
/** Returns all characters that are not letters of any locale.
* @return a set with all characters that are not letters of any locale */
public static Set getNonWordChars() {
return new CharSet(' ', '@').addRange('[', '`').addRange('{', '~').getSet();
}
// whitespace related interface ------------------------------------------------------------------------------------
/**
* Adds all whitespace characters.
* @return this
*/
public CharSet addWhitespaces() {
return addAll(getWhitespaces());
}
/**
* Removes all whitespace characters.
* @return this
*/
public CharSet removeWhitespaces() {
return removeAll(getWhitespaces());
}
/**
* Returns all whitespace characters.
* @return a Set of all whitespace charaters
*/
public static Set getWhitespaces() {
return new CharSet().add(' ').add('\t').add('\n').add((char)0x0B).add('\f').add('\r').getSet();
}
/**
* Adds all characters that are not white spaces.
* @return this
*/
public CharSet addNonWhitespaces() {
return addAll(getNonWhitespaces());
}
/**
* Removes all characters that are not white spaces.
* @return this
*/
public CharSet removeNonWhitespaces() {
return removeAll(getNonWhitespaces());
}
/**
* Returns a set of all characters that are not white spaces.
* @return a set of all characters that are not white spaces
*/
public static Set getNonWhitespaces() {
return new CharSet().addAnyCharacters().removeAll(getWhitespaces()).getSet();
}
// low level interface ---------------------------------------------------------------------------------------------
/** Adds any character.
* @return this */
public CharSet addAnyCharacters() {
return addAll(getAnyCharacters());
}
/**
* Returns any characters.
* @return a set of any characters
*/
public static Set getAnyCharacters() {
Set set = new HashSet();
for (int c = 0x20; c < 0x7F; c++)
set.add((char) c);
return set;
}
/**
* Clears the set.
* @return this
*/
public CharSet removeAll() {
set.clear();
return this;
}
/**
* Adds a range of characters.
* @param from the first character to add
* @param to the last character to add
* @return this
*/
public CharSet addRange(char from, char to) {
for (char c = from ; c <= to; c++)
set.add(c);
return this;
}
/**
* Adds a single character.
* @param c the character to add
* @return this
*/
public CharSet add(char c) {
set.add(c);
return this;
}
/**
* Adds a set of characters.
* @param chars the characters to include
* @return this
*/
public CharSet addAll(Set chars) {
set.addAll(chars);
return this;
}
/**
* Removes all characters of the specified set.
* @param chars the characters to remove
* @return this
*/
public CharSet removeAll(Set chars) {
set.removeAll(chars);
return this;
}
/**
* Removes a range of characters.
* @param min the first character to remove
* @param max the last character to remove
* @return this
*/
public CharSet removeRange(char min, char max) {
for (char c = min; c <= max; c++)
remove(c);
return this;
}
/**
* Removes one character.
* @param c the character to remove
* @return this
*/
public CharSet remove(char c) {
if (set.contains(c))
set.remove(c);
return this;
}
/**
* Returns a copy of the wrapped Set as HashSet.
* @return a copy of the wrapped Set as HashSet
*/
public Set getSet() {
return new HashSet(set);
}
public Iterator iterator() {
return set.iterator();
}
public boolean contains(char c) {
return set.contains(c);
}
public int size() {
return set.size();
}
public boolean containsAll(Set set) {
return (this.set.containsAll(set));
}
// java.lang.Object overrides --------------------------------------------------------------------------------------
/**
* Returns a String representation of the Set
* @return a String representation of the Set
* @see java.lang.Object
*/
@Override
public String toString() {
if (name != null)
return name;
else
return set.toString();
}
/**
* Compares with another Set, ignoring the locale.
* @see java.lang.Object
*/
@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (o == null || getClass() != o.getClass())
return false;
final CharSet charSet = (CharSet) o;
return set.equals(charSet.set);
}
/**
* Calculates the Set's hashCode, ignoring the locale.
* @return the Set'S hash code
* @see java.lang.Object
*/
@Override
public int hashCode() {
return set.hashCode();
}
@Override
public CharSet clone() {
try {
return (CharSet) super.clone();
} catch (CloneNotSupportedException e) {
throw new RuntimeException("Unexpected exception", e);
}
}
}