MockBindRule.java

/*
 * Grapht, an open source dependency injector.
 * Copyright 2014-2015 various contributors (see CONTRIBUTORS.txt)
 * Copyright 2010-2014 Regents of the University of Minnesota
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.grouplens.grapht.solver;

import org.grouplens.grapht.CachePolicy;
import org.grouplens.grapht.reflect.Desire;
import org.grouplens.grapht.reflect.MockQualifierMatcher;
import org.grouplens.grapht.reflect.QualifierMatcher;

import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;

/**
 * MockBindRule is a simple implementation of BindRule where the matching
 * bindings are represented as a map from input Desires to output Desires, via
 * {@link #addMapping(Desire, Desire)}.
 * 
 * @author <a href="http://grouplens.org">GroupLens Research</a>
 */
public class MockBindRule implements BindRule {
    private final Map<Desire, Desire> bindings;
    private boolean terminate;
    private CachePolicy policy;
    
    public MockBindRule() {
        bindings = new HashMap<Desire, Desire>();
        policy = CachePolicy.NO_PREFERENCE;
    }
    
    public MockBindRule(Desire in, Desire out) {
        this();
        addMapping(in, out);
    }
    
    public MockBindRule setCachePolicy(CachePolicy policy) {
        this.policy = policy;
        return this;
    }
    
    public MockBindRule setTerminatesChain(boolean terminate) {
        this.terminate = terminate;
        return this;
    }
    
    public MockBindRule addMapping(Desire in, Desire out) {
        bindings.put(in, out);
        return this;
    }
    
    @Override
    public CachePolicy getCachePolicy() {
        return policy;
    }
    
    @Override
    public boolean matches(Desire desire) {
        return bindings.containsKey(desire);
    }

    @Override
    public Desire apply(Desire desire) {
        return bindings.get(desire);
    }

    @Override
    public EnumSet<BindingFlag> getFlags() {
        if (terminate) {
            return EnumSet.of(BindingFlag.TERMINAL);
        } else {
            return BindingFlag.emptySet();
        }
    }

    @Override
    public boolean isTerminal() {
        return terminate;
    }
    
    public QualifierMatcher getQualifier() {
        return MockQualifierMatcher.any();
    }

    @Override
    public BindRuleBuilder newCopyBuilder() {
        throw new UnsupportedOperationException("cannot configure mock bind rules");
    }

    public int compareTo(BindRule other) {
        return getQualifier().compareTo(((MockBindRule) other).getQualifier());
    }

    @Override
    public String toString() {
        return getClass() + "@" + Integer.toHexString(System.identityHashCode(this));
    }
}