MockDesire.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.reflect;

import java.lang.annotation.Annotation;

/**
 * MockDesire is a simple Desire implementation for use within certain types of
 * tests.
 * 
 * @author <a href="http://grouplens.org">GroupLens Research</a>
 */
public class MockDesire implements Desire {
    private static final long serialVersionUID = 1L;

    private final Annotation qualifier;
    private final Satisfaction satisfaction;
    private final Class<?> desiredType;
    
    public MockDesire() {
        this(null);
    }
    
    public MockDesire(Satisfaction satisfaction) {
        this(satisfaction, null);
    }
    
    public MockDesire(Satisfaction satisfaction, Annotation qualifier) {
        this((satisfaction == null ? Void.class : satisfaction.getErasedType()),
             satisfaction, qualifier);
    }
    
    public MockDesire(Class<?> desiredType, Satisfaction satisfaction, Annotation qualifier) {
        this.desiredType = desiredType;
        this.satisfaction = satisfaction;
        this.qualifier = qualifier;
    }
    
    @Override
    public boolean isInstantiable() {
        return satisfaction != null;
    }

    @Override
    public Satisfaction getSatisfaction() {
        return satisfaction;
    }

    @Override
    public Class<?> getDesiredType() {
        return desiredType;
    }

    @Override
    public InjectionPoint getInjectionPoint() {
        return Desires.createInjectionPoint(qualifier, getDesiredType(), false);
    }

    @Override
    public Desire restrict(Class<?> type) {
        return new MockDesire(type, satisfaction, qualifier);
    }

    @Override
    public Desire restrict(Satisfaction satisfaction) {
        return new MockDesire(satisfaction.getErasedType(), satisfaction, qualifier);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("mock desire for ")
          .append(desiredType);
        if (qualifier != null) {
            sb.append(" with qualifier ")
              .append(qualifier);
        }
        if (satisfaction != null) {
            sb.append(" (satisfied by ")
              .append(satisfaction)
              .append(")");
        }
        return sb.toString();
    }
}