SpecificationNot.java

/*
 *  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.isis.applib.spec;

/**
 * Adapter to make it easy to perform boolean algebra on {@link Specification}s.
 * 
 * <p>
 * <p>
 * Subclasses represent the logical inverse of a {@link Specification}s. An
 * implementation should instantiate the {@link Specification}s to be satisfied
 * in its constructor.
 * 
 * <p>
 * For example:
 * 
 * <pre>
 * public class NoSugarThanksSpec extends SpecificationNot {
 *     public NoSugarThanksSpec() {
 *         super(
 *             new TwoLumpsOfSugarSpec(), 
 *         );
 *     }
 * }
 * </pre>
 * 
 * @see SpecificationAnd
 * @see SpecificationOr
 */
public abstract class SpecificationNot implements Specification {

    private final Specification specification;

    public SpecificationNot(final Specification specification) {
        this.specification = specification;
    }

    @Override
    public String satisfies(final Object obj) {
        final String satisfies = specification.satisfies(obj);
        return satisfies != null ? null : "not satisfied";
    }
}