/*
 * 
 jFin, open source derivatives trade processing 
 *
 * 
 Copyright (C) 2005, 2006, 2007 Morgan Brown Consultancy Ltd. 
 *
 * 
 This file is part of jFin. 
 *
 * 
 jFin is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version. 
 *
 * 
 jFin 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 jFin; if not, write to the Free Software Foundation, Inc., 51 Franklin
 * St, Fifth Floor, Boston, MA 02110-1301 USA. 
 */

package org.jfin.date;

/**
 * 

 * Enumeration of the various stub types, currently supports:
 * 
 *
 * 

 * 
 Undajusted
 * 
 Preceding
 * 
 Modified Preceding
 * 
 Following
 * 
 Modified Following
 * 
 Month End Reference
 * 
 */
public enum StubType
{
	/*
	 * pluggable ScheduleGenerators <-- Preferred but would need to see concrete
	 * examples Rely on end developer to create specific classes for specific
	 * instruments
	 */

	/**
	 * The short stub period is at the start of the schedule, e.g.:
	 *
	 * X.X...X...X...X...X...X...X
	 */
	SHORT_FIRST(false,true),

	/**
	 * The short stub period is at the end of the schedule
	 *
	 * X...X...X...X...X...X...X.X
	 */
	SHORT_LAST(false,true),

	/**
	 * The long stub period is at the start of the schedule, e.g.:
	 *
	 * X.....X...X...X...X...X...X
	 */
	LONG_FIRST(true,false),

	/**
	 * The long stub period is at the end of the schedule
	 *
	 * X...X...X...X...X...X.....X
	 */
	LONG_LAST(true,false),

	/**
	 * There should be no stub period, if the frequency doesn't exactly fit the
	 * start/end date then an exception will be thrown
	 *
	 * X...X...X...X...X...X...X
	 */
	NONE(false,false);

	private boolean longStub;
	private boolean shortStub;


	private StubType(boolean longStub, boolean shortStub) {
		this.longStub = longStub;
		this.shortStub = shortStub;
	}


	public boolean isLongStub() {
		return longStub;
	}

	public boolean isShortStub() {
		return shortStub;
	}
}