/*
 *  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.causeway.core.metamodel.spec.feature;

import java.util.function.Predicate;

public enum MixedIn {
    /** Member search scope including mixed in members.*/
    INCLUDED {

        @Override
        public Predicate<? super ObjectMember> toFilter() {
            return member->true;
        }

    },

    /** Member search scope excluding mixed in members.*/
    EXCLUDED {

        @Override
        public Predicate<? super ObjectMember> toFilter() {
            return member->!(member instanceof MixedInMember);
        }

    },

    /** Member search scope only considering mixed in members.*/
    ONLY {

        @Override
        public Predicate<? super ObjectMember> toFilter() {
            return member->(member instanceof MixedInMember);
        }

    };

    public boolean isIncluded() { return this == INCLUDED; }
    public boolean isExcluded() { return this == EXCLUDED; }
    public boolean isOnly() { return this == ONLY; }

    public abstract Predicate<? super ObjectMember> toFilter();

}