• Home
• net.java.truecommons
• truecommons-shed
• 2.3.5
• source code
• BitField.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.java.truecommons.shed.BitField Maven / Gradle / Ivy

/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.truecommons.shed;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Iterator;
import javax.annotation.CheckForNull;
import javax.annotation.concurrent.Immutable;

/**
 * A type-safe, immutable set of enums which emulates the concept of a bit
 * field, i.e. a set of predefined bits.
 * As an immutable class, it's inherently thread-safe.
 * All modifying methods return a modified clone of this instance.
 *
 * @param   The type of {@link Enum} objects contained in this set.
 * @author Christian Schlichtherle
 */
// TODO: Add more modifying methods.
@Immutable
public final class BitField>
implements Iterable, Serializable {

    private static final long serialVersionUID = 3203876204846746524L;

    private final EnumSet bits;

    /**
     * Returns a bit field which can contain the given element type and is
     * initially empty.
     * 

     * This could be used like this:
     * 
{@code
     *  BitField field = BitField.noneOf(Option.class);
     * }
     * where {@code Option} is an arbitrary enum type.
     */
    public static > BitField
    noneOf(Class elementType) {
        return new BitField<>(elementType, false);
    }

    /**
     * Returns a bit field which contains all enums of the given element type.
     * 

     * This could be used like this:
     * 
{@code
     *  BitField field = BitField.allOf(Option.class);
     * }
     * where {@code Option} is an arbitrary enum type.
     */
    public static > BitField
    allOf(Class elementType) {
        return new BitField<>(elementType, true);
    }

    /**
     * Returns a bit field which contains the given bit.
     * 

     * This could be used like this:
     * 
{@code
     *  BitField field = BitField.of(Option.ONE);
     * }
     * where {@code Option.ONE} is an arbitrary enum.
     */
    public static > BitField
    of(E bit) {
        return new BitField<>(bit);
    }

    /**
     * Returns a bit field which contains the given bits.
     * 

     * This could be used like this:
     * 
{@code
     *  BitField field = BitField.of(Option.ONE, Option.TWO);
     * }
     * where {@code Option.ONE} and {@code Option.TWO} are arbitrary enums.
     */
    public static > BitField
    of(E bit, E... bits) {
        return new BitField<>(bit, bits);
    }

    /**
     * Returns a bit field which contains the same bits as the given collection
     * of enums.
     * 

     * This could be used like this:
     * 
{@code
     *  BitField field = BitField.of(bits);
     * }
     * where {@code bits} is an {@code EnumSet}.
     */
    public static > BitField
    copyOf(Collection bits) {
        return new BitField<>(EnumSet.copyOf(bits));
    }

    /** @deprecated Required for XMLEncoder/XMLDecoder - do not use! */
    public static > BitField
    of(final Class elementType, final String list) {
        final EnumSet bits = EnumSet.noneOf(elementType);
        for (final String bit : list.split("\\|"))
            bits.add(Enum.valueOf(elementType, bit));
        return new BitField<>(bits);
    }

    /**
     * Constructs a new bit field which contains all or none of the enums
     * of the given element type.
     */
    private BitField(Class elementType, boolean allOf) {
        this.bits = allOf   ? EnumSet.allOf (elementType)
                            : EnumSet.noneOf(elementType);
    }

    /** Constructs a new bit field which contains the given bit. */
    private BitField(E bit) {
        this.bits = EnumSet.of(bit);
    }

    /** Constructs a new bit field which contains the given bits. */
    private BitField(E bit, E... bits) {
        this.bits = EnumSet.of(bit, bits);
    }

    /**
     * Constructs a new bit field by sharing the given set of enums.
     * Note that this constructor does not make a protective copy
     * - use with care!
     *
     * @param bits the set of enums to share with this instance.
     */
    private BitField(final EnumSet bits) {
        assert null != bits;
        this.bits = bits;
    }

    /**
     * Returns {@code true} if and only if all bits are cleared in this bit
     * field.
     */
    public boolean isEmpty() {
        return bits.isEmpty();
    }

    /** Returns the number of bits set in this field. */
    public int cardinality() {
        return bits.size();
    }

    /**
     * Returns {@code true} if and only if the given bit is set.
     *
     * @param bit The bit to test.
     */
    public boolean get(E bit) {
        return bits.contains(bit);
    }

    /** Equivalent to {@link #get(Enum) get(bit)}. */
    public boolean is(E bit) {
        return bits.contains(bit);
    }

    /**
     * Sets or clears the given bit.
     * 

     * Subclasses could override this method in order to cache frequently used
     * results, such as a null bit field, a single bit field etc.
     *
     * @param bit The bit to set or clear.
     * @param set Whether the bit shall get set or cleared.
     */
    public BitField set(final E bit, final boolean set) {
        final EnumSet bits;
        if (set) {
            if (this.bits.contains(bit))
                return this;
            bits = this.bits.clone();
            bits.add(bit);
        } else {
            if (!this.bits.contains(bit))
                return this;
            bits = this.bits.clone();
            bits.remove(bit);
        }
        return new BitField<>(bits);
    }

    /** Sets the given bit. */
    public BitField set(E bit) {
        return set(bit, true);
    }

    /** Clears the given bit. */
    public BitField clear(E bit) {
        return set(bit, false);
    }

    public BitField not() {
        return new BitField<>(EnumSet.complementOf(bits));
    }

    public BitField and(BitField that) {
        final EnumSet bits = this.bits.clone();
        return bits.retainAll(that.bits) ? new BitField<>(bits) : this;
    }

    public BitField or(BitField that) {
        final EnumSet bits = this.bits.clone();
        return bits.addAll(that.bits) ? new BitField<>(bits) : this;
    }

    /** Returns a read-only iterator for the bits in this field. */
    @Override
    public Iterator iterator() {
        return Collections.unmodifiableSet(bits).iterator();
    }

    /**
     * Returns a new set of enums containing the same bits as this instance.
     * The following boolean identity expression is always true for any
     * non-{@code null} bit field {@code bits}:
     * {@code bits.equals(BitField.copyOf(bits.toEnumSet()))}.
     *
     * @return a new set of enums containing the same bits as this instance.
     */
    public EnumSet toEnumSet() {
        return bits.clone();
    }

    /**
     * Returns {@code true} if and only if the given object is another
     * {@code BitField} and contains the same bits.
     */
    @Override
    public boolean equals(@CheckForNull Object that) {
        return this == that
                || that instanceof BitField
                    && this.bits.equals(((BitField) that).bits);
    }

    /** Returns a hash code which is consistent with {@link #equals}. */
    @Override
    public int hashCode() {
        return bits.hashCode();
    }

    /**
     * Returns a concatenation of the names of the bits in this field,
     * separated by {@code "|"}.
     */
    @Override
    public String toString() {
        final int capacity = bits.size() * 11;
        if (0 >= capacity)
            return "";
        final StringBuilder s = new StringBuilder(capacity);
        for (final E bit : bits) {
            if (s.length() > 0)
                s.append('|');
            s.append(bit);
        }
        return s.toString();
    }
}