org.qedeq.kernel.bo.module.KernelQedeqBoSet Maven / Gradle / Ivy
/* This file is part of the project "Hilbert II" - http://www.qedeq.org
*
* Copyright 2000-2013, Michael Meyling .
*
* "Hilbert II" is free software; you can redistribute
* it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
package org.qedeq.kernel.bo.module;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import org.qedeq.kernel.bo.common.QedeqBo;
import org.qedeq.kernel.bo.common.QedeqBoSet;
/**
* This class represents a set of {@link KernelQedeqBo}s.
*
* @author Michael Meyling
*/
public class KernelQedeqBoSet implements QedeqBoSet {
/** Here are the elements stored. */
private final Set elements;
/**
* Constructs an empty element set.
*/
public KernelQedeqBoSet() {
this.elements = new HashSet();
}
/**
* Constructs an element set.
*
* @param elements the elements to put into the set
* @throws IllegalArgumentException if elements was a NullPointer
*/
public KernelQedeqBoSet(final KernelQedeqBo[] elements) {
if (elements == null) {
throw new IllegalArgumentException(
"NullPointer as element array is not allowed");
}
this.elements = new HashSet(Arrays.asList(elements));
}
/**
* Constructs an element set.
*
* @param element Put this element into the set
* @throws IllegalArgumentException if element was a NullPointer
*/
public KernelQedeqBoSet(final KernelQedeqBo element) {
if (element == null) {
throw new IllegalArgumentException(
"NullPointer as element array is not allowed");
}
this.elements = new HashSet();
elements.add(element);
}
/**
* Constructs an element set.
*
* @param set contains the elements to put into the set
* @throws IllegalArgumentException if set was a
* NullPointer
*/
public KernelQedeqBoSet(final KernelQedeqBoSet set) {
if (set == null) {
throw new IllegalArgumentException(
"NullPointer as set is not allowed");
}
this.elements = new HashSet(set.elements);
}
/**
* Is element in set?
*
* @param element KernelQedeqBo to check for.
* @return Is element in this set?
* @throws IllegalArgumentException if the element was a
* NullPointer
*/
public final boolean contains(final KernelQedeqBo element) {
if (element == null) {
throw new IllegalArgumentException("NullPointer as element is not allowed");
}
return this.elements.contains(element);
}
public boolean contains(final QedeqBo element) {
if (element == null) {
throw new IllegalArgumentException("NullPointer as element is not allowed");
}
return this.elements.contains(element);
}
/**
* Is this set empty?
*
* @return Is this set empty?
*/
public final boolean isEmpty() {
return elements.isEmpty();
}
/**
* Add an element to set. This object is after the method the
* union of this set with {element}
*
* @param element element to put into the set
* @return Possibly changed this.
* @throws IllegalArgumentException if the element was a
* NullPointer
*/
public final KernelQedeqBoSet add(final KernelQedeqBo element) {
if (element == null) {
throw new IllegalArgumentException("NullPointer as element is not allowed");
}
elements.add(element);
return this;
}
/**
* Add elements from another {@link KernelQedeqBoSet} to this set.
* After this method this object is the union of the two sets.
*
* @param set add all elements that are here
* @return Possibly changed this.
* @throws IllegalArgumentException if the set was a
* NullPointer
*/
public final KernelQedeqBoSet add(final KernelQedeqBoSet set) {
if (set == null) {
throw new IllegalArgumentException(
"NullPointer as set is not allowed");
}
elements.addAll(set.elements);
return this;
}
/**
* Remove an element from this set.
*
* @param element KernelQedeqBo to remove from the set. Must not be null.
* @return Possibly changed this.
* @throws IllegalArgumentException if the element was a
* NullPointer
*/
public final KernelQedeqBoSet remove(final KernelQedeqBo element) {
if (element == null) {
throw new IllegalArgumentException(
"NullPointer as element is not allowed");
}
elements.remove(element);
return this;
}
/**
* Remove elements from another {@link KernelQedeqBoSet} from this set.
* After this method this object is the asymmetric set difference of the
* two sets: this \ set.
*
* @param set Remove all elements that are in this set from
* this.
* @return Possibly changed this.
* @throws IllegalArgumentException if the set was a
* NullPointer
*/
public final KernelQedeqBoSet remove(final KernelQedeqBoSet set) {
if (set == null) {
throw new IllegalArgumentException(
"NullPointer as set is not allowed");
}
this.elements.removeAll(set.elements);
return this;
}
/**
* Build the intersection.
*
* @param set Check for these elements.
* @return Possibly changed this.
* @throws IllegalArgumentException if the set was a
* NullPointer
*/
public final KernelQedeqBoSet intersection(final KernelQedeqBoSet set) {
if (set == null) {
throw new IllegalArgumentException(
"NullPointer as set is not allowed");
}
this.elements.retainAll(set.elements);
return this;
}
/**
* Get number of elements.
*
* @return Number of elements in this set.
*/
public final int size() {
return this.elements.size();
}
/**
* Returns an iterator over the elements in this set. The elements are
* returned in no particular order (unless this set is an instance of some
* class that provides a guarantee).
*
* @return Iterator over the elements in this set.
*/
public Iterator iterator() {
return this.elements.iterator();
}
public final boolean equals(final Object obj) {
if (obj instanceof KernelQedeqBoSet) {
return this.elements.equals(((KernelQedeqBoSet) obj).elements);
}
return false;
}
public final int hashCode() {
return elements.hashCode();
}
public final String toString() {
final StringBuffer result = new StringBuffer();
result.append("{");
final Iterator iterator = elements.iterator();
while (iterator.hasNext()) {
result.append(iterator.next());
if (iterator.hasNext()) {
result.append(", ");
}
}
result.append("}");
return result.toString();
}
public String asLongList() {
final StringBuffer result = new StringBuffer();
final Iterator iterator = elements.iterator();
while (iterator.hasNext()) {
result.append(((QedeqBo) iterator.next()).getUrl());
if (iterator.hasNext()) {
result.append(", ");
}
}
return result.toString();
}
public String asShortList() {
final StringBuffer result = new StringBuffer();
final Iterator iterator = elements.iterator();
while (iterator.hasNext()) {
result.append(((QedeqBo) iterator.next()).getName());
if (iterator.hasNext()) {
result.append(", ");
}
}
return result.toString();
}
}