home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Commons Collections example source code file (PredicatedBag.java)

This example Commons Collections source code file (PredicatedBag.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Commons Collections tags/keywords

bag, bag, predicate, predicate, predicatedbag, predicatedbag, predicatedcollection, predicatedcollection, set, util

The Commons Collections PredicatedBag.java source code

/*
 *  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.collections.bag;

import java.util.Set;

import org.apache.commons.collections.Bag;
import org.apache.commons.collections.Predicate;
import org.apache.commons.collections.collection.PredicatedCollection;

/**
 * Decorates another <code>Bag to validate that additions
 * match a specified predicate.
 * <p>
 * This bag exists to provide validation for the decorated bag.
 * It is normally created to decorate an empty bag.
 * If an object cannot be added to the bag, an IllegalArgumentException is thrown.
 * <p>
 * One usage would be to ensure that no null entries are added to the bag.
 * <pre>Bag bag = PredicatedBag.decorate(new HashBag(), NotNullPredicate.INSTANCE);
* <p> * This class is Serializable from Commons Collections 3.1. * * @since Commons Collections 3.0 * @version $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $ * * @author Stephen Colebourne * @author Paul Jack */ public class PredicatedBag extends PredicatedCollection implements Bag { /** Serialization version */ private static final long serialVersionUID = -2575833140344736876L; /** * Factory method to create a predicated (validating) bag. * <p> * If there are any elements already in the bag being decorated, they * are validated. * * @param bag the bag to decorate, must not be null * @param predicate the predicate to use for validation, must not be null * @return a new predicated Bag * @throws IllegalArgumentException if bag or predicate is null * @throws IllegalArgumentException if the bag contains invalid elements */ public static Bag decorate(Bag bag, Predicate predicate) { return new PredicatedBag(bag, predicate); } //----------------------------------------------------------------------- /** * Constructor that wraps (not copies). * <p> * If there are any elements already in the bag being decorated, they * are validated. * * @param bag the bag to decorate, must not be null * @param predicate the predicate to use for validation, must not be null * @throws IllegalArgumentException if bag or predicate is null * @throws IllegalArgumentException if the bag contains invalid elements */ protected PredicatedBag(Bag bag, Predicate predicate) { super(bag, predicate); } /** * Gets the decorated bag. * * @return the decorated bag */ protected Bag getBag() { return (Bag) getCollection(); } //----------------------------------------------------------------------- public boolean add(Object object, int count) { validate(object); return getBag().add(object, count); } public boolean remove(Object object, int count) { return getBag().remove(object, count); } public Set uniqueSet() { return getBag().uniqueSet(); } public int getCount(Object object) { return getBag().getCount(object); } }

Other Commons Collections examples (source code examples)

Here is a short list of links related to this Commons Collections PredicatedBag.java source code file:

new blog posts

 

Copyright 1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.