CollectionContainment.java

/*
 * Copyright 2006 the original author or authors.
 *
 * 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 jdave.containment;

import java.util.Collection;
import java.util.Iterator;

import jdave.BaseMatcherContainment;
import jdave.util.Collections;

/**
 * @author Joni Freeman
 */
public abstract class CollectionContainment<T> extends BaseMatcherContainment<T> {
    protected final Collection<T> elements;

    public CollectionContainment(final Collection<T> elements) {
        this.elements = elements;
    }

    public CollectionContainment(final Iterator<T> elements) {
        this(Collections.list(elements));
    }

    public CollectionContainment(final Iterable<T> elements) {
        this(elements.iterator());
    }

    public boolean matches(final Collection<T> actual) {
        if (actual == null) {
            return false;
        }
        this.actual = actual;
        return nullSafeMatches(actual);
    }

    protected abstract boolean nullSafeMatches(Collection<T> actual);

    @Override
    public String toString() {
        return elements.toString();
    }

    public String error(final Collection<T> actual) {
        return "The specified collection '" + actual + "' does not contain '" + this + "'";
    }
}