All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.nakedobjects.applib.fixtures.AbstractFixture Maven / Gradle / Ivy

    There is a newer version: 4.0.0
    Show newest version
    package org.nakedobjects.applib.fixtures;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.nakedobjects.applib.AbstractContainedObject;
import org.nakedobjects.applib.clock.Clock;
import org.nakedobjects.applib.switchuser.SwitchUserService;
import org.nakedobjects.applib.switchuser.SwitchUserServiceAware;


/**
 * Convenience class for creating fixtures.
 * 
 * 
    
 * Most subclasses will simply override {@link #install()} to setup objects.  In addition though
 * fixtures may also:
 * 
      
 * 
    • change the date/time within the course of fixture installation, using {@link #setDate(int, int, int)} and
 *     {@link #setTime(int, int)}.
 * 
    • change the current user using {@link #switchUser(String, String...)}.
 * 
    • create composite fixtures using {@link #addFixture(Object)}.
 * 
    • search for existing objects using {@link #firstMatch(Class, org.nakedobjects.applib.Filter)} or
 * {@link #uniqueMatch(Class, org.nakedobjects.applib.Filter)} (and various overloads thereof).
 * 
    
 * 
 * 
    
 * To automatically logon for the demo/test, use 
 */
public abstract class AbstractFixture extends AbstractContainedObject implements InstallableFixture, CompositeFixture, SwitchUserServiceAware {
	
    private final List fixtures = new ArrayList();
    
    // is initialized in constructor
	private FixtureClock clock = null;
	private final FixtureType fixtureType;

	/**
	 * Assumed to be {@link FixtureType#OBJECT_STORE data} fixture.
	 */
    public AbstractFixture() {
    	this(FixtureType.OBJECT_STORE);
    }

    public AbstractFixture(final FixtureType fixtureType) {
    	this.fixtureType = fixtureType;
    	try {
    		clock = FixtureClock.initialize();
    	} catch(IllegalStateException ex) {
    		clock = null;
    		System.err.println(ex.getMessage());
    		System.err.println("calls to change date or time will be ignored");
    	}
    }

    /**
     * As specified in constructor.
     */
    public FixtureType getType() {
		return fixtureType;
	}
    
    /**
     * Most subclasses will override this method, but composite fixtures
     * should instead call {@link #addFixture(Object)} in their constructor.
     */
    public void install() {}

    /**
     * Allows the fixture to act as a composite (call within constructor).
     */
    protected void addFixture(final Object fixture) {
        fixtures.add(fixture);
    }

    /**
     * Returns an array of any fixtures that have been {@link #addFixture(Object) added}.
     */
    public List getFixtures() {
        return Collections.unmodifiableList(fixtures);
    }



    // {{ Clock
    /**
     * The {@link Clock} singleton, downcast to {@link FixtureClock}.
     * 
     * 
    
     * Will return null if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public FixtureClock getFixtureClock() {
        return clock;
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void earlierDate(final int years, final int months, final int days) {
    	if (clockNotSetup("earlierDate")) return;
        clock.addDate(-years, -months, -days);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
	public void earlierTime(final int hours, final int minutes) {
    	if (clockNotSetup("earlierDate")) return;
        clock.addTime(-hours, -minutes);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void laterDate(final int years, final int months, final int days) {
    	if (clockNotSetup("laterDate")) return;
        clock.addDate(years, months, days);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void laterTime(final int hours, final int minutes) {
    	if (clockNotSetup("laterTime")) return;
        clock.addTime(hours, minutes);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void resetClock() {
    	if (clockNotSetup("laterTime")) return;
        clock.reset();
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void setDate(final int year, final int month, final int day) {
    	if (clockNotSetup("setDate")) return;
        clock.setDate(year, month, day);
    }

    /**
     * Will print warning message and do nothing if {@link FixtureClock} could not be {@link FixtureClock#initialize() initialized}.
     */
    public void setTime(final int hour, final int minute) {
    	if (clockNotSetup("setTime")) return;
        clock.setTime(hour, minute);
    }

    private boolean clockNotSetup(String methodName) {
    	if (clock == null) {
    		System.err.println("clock not set, call to " + methodName + " ignored");
    		return true;
    	}
		return false;
	}
    // }}

    
    // {{ User
    protected void switchUser(final String username, final String... roles) {
        switchUserService.switchUser(username, roles);
    }
    // }}


    // {{ Injected: SwitchUserService
	private SwitchUserService switchUserService;
    public void setService(final SwitchUserService fixtureService) {
        this.switchUserService = fixtureService;
    }
    // }}

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy