All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.groupbyinc.common.apache.commons.collections4.bag.TransformedBag Maven / Gradle / Ivy

There is a newer version: 198
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.collections4.bag;

import java.util.Set;

import org.apache.commons.collections4.Bag;
import org.apache.commons.collections4.Transformer;
import org.apache.commons.collections4.collection.TransformedCollection;
import org.apache.commons.collections4.set.TransformedSet;

/**
 * Decorates another {@link Bag} to transform objects that are added.
 * 

* The add methods are affected by this class. * Thus objects must be removed or searched for using their transformed form. * For example, if the transformation converts Strings to Integers, you must * use the Integer form to remove objects. *

* This class is Serializable from Commons Collections 3.1. * * @since 3.0 * @version $Id: TransformedBag.java 1686855 2015-06-22 13:00:27Z tn $ */ public class TransformedBag extends TransformedCollection implements Bag { /** Serialization version */ private static final long serialVersionUID = 5421170911299074185L; /** * Factory method to create a transforming bag. *

* If there are any elements already in the bag being decorated, they * are NOT transformed. Contrast this with {@link #transformedBag(Bag, Transformer)}. * * @param the type of the elements in the bag * @param bag the bag to decorate, must not be null * @param transformer the transformer to use for conversion, must not be null * @return a new transformed Bag * @throws NullPointerException if bag or transformer is null * @since 4.0 */ public static Bag transformingBag(final Bag bag, final Transformer transformer) { return new TransformedBag(bag, transformer); } /** * Factory method to create a transforming bag that will transform * existing contents of the specified bag. *

* If there are any elements already in the bag being decorated, they * will be transformed by this method. * Contrast this with {@link #transformingBag(Bag, Transformer)}. * * @param the type of the elements in the bag * @param bag the bag to decorate, must not be null * @param transformer the transformer to use for conversion, must not be null * @return a new transformed Bag * @throws NullPointerException if bag or transformer is null * @since 4.0 */ public static Bag transformedBag(final Bag bag, final Transformer transformer) { final TransformedBag decorated = new TransformedBag(bag, transformer); if (bag.size() > 0) { @SuppressWarnings("unchecked") // Bag is of type E final E[] values = (E[]) bag.toArray(); // NOPMD - false positive for generics bag.clear(); for (final E value : values) { decorated.decorated().add(transformer.transform(value)); } } return decorated; } //----------------------------------------------------------------------- /** * Constructor that wraps (not copies). *

* If there are any elements already in the bag being decorated, they * are NOT transformed. * * @param bag the bag to decorate, must not be null * @param transformer the transformer to use for conversion, must not be null * @throws NullPointerException if bag or transformer is null */ protected TransformedBag(final Bag bag, final Transformer transformer) { super(bag, transformer); } /** * Gets the decorated bag. * * @return the decorated bag */ protected Bag getBag() { return (Bag) decorated(); } @Override public boolean equals(final Object object) { return object == this || decorated().equals(object); } @Override public int hashCode() { return decorated().hashCode(); } //----------------------------------------------------------------------- @Override public int getCount(final Object object) { return getBag().getCount(object); } @Override public boolean remove(final Object object, final int nCopies) { return getBag().remove(object, nCopies); } //----------------------------------------------------------------------- @Override public boolean add(final E object, final int nCopies) { return getBag().add(transform(object), nCopies); } @Override public Set uniqueSet() { final Set set = getBag().uniqueSet(); return TransformedSet.transformingSet(set, transformer); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy