org.eclipse.rap.rwt.lifecycle.PhaseId Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2002, 2012 Innoopract Informationssysteme GmbH and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Innoopract Informationssysteme GmbH - initial API and implementation
* EclipseSource - ongoing development
******************************************************************************/
package org.eclipse.rap.rwt.lifecycle;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
/**
* A type-safe enumeration that represents all standard life cycle phases. The
* instances can be used to refer to a phase in implementations of
* {@link PhaseListener}.
*
* @since 2.0
* @noextend This class is not intended to be subclassed by clients.
*/
public class PhaseId implements Comparable {
private static int nextOrdinal;
/**
* The PhaseId ANY is used by the {@link PhaseListener} to
* signal interest in all phases.
*/
public static final PhaseId ANY = new PhaseId( "ANY" );
/**
* The PhaseId PREPARE_UI_ROOT is used by the
* {@link PhaseListener} to signal interest in the Prepare UI Root
* phase.
*/
public static final PhaseId PREPARE_UI_ROOT = new PhaseId( "PREPARE_UI_ROOT" );
/**
* The PhaseId READ_DATA is used by the {@link PhaseListener}
* to signal interest in the Read Data phase.
*/
public static final PhaseId READ_DATA = new PhaseId( "READ_DATA" );
/**
* The PhaseId PROCESS_ACTION is used by the
* {@link PhaseListener} to signal interest in the Process Action
* phase.
*/
public static final PhaseId PROCESS_ACTION = new PhaseId( "PROCESS_ACTION" );
/**
* The PhaseId RENDER is used by the {@link PhaseListener} to
* signal interest in the Render phase.
*/
public static final PhaseId RENDER = new PhaseId( "RENDER" );
private final static PhaseId[] values = new PhaseId[] {
ANY,
PREPARE_UI_ROOT,
READ_DATA,
PROCESS_ACTION,
RENDER
};
/**
* A list containing the instances of this enumeration.
*/
public static final List VALUES = Collections.unmodifiableList( Arrays.asList( values ) );
private final String name;
private final int ordinal;
private PhaseId( String name ) {
this.name = name;
ordinal = nextOrdinal++;
}
@Override
public String toString() {
return name;
}
public int compareTo( Object toCompare ) {
return ordinal - ( ( PhaseId )toCompare ).ordinal;
}
/**
* Returns the ordinal number that is used for comparison of PhaseIds.
*
* @return the ordinal number
*/
public int getOrdinal() {
return ordinal;
}
}