Package org.hippoecm.hst.container.valves

Class AbstractOrderableValve

java.lang.Object

org.hippoecm.hst.container.valves.AbstractValve

org.hippoecm.hst.container.valves.AbstractOrderableValve

All Implemented Interfaces:

OrderableValve, Valve

public abstract class AbstractOrderableValve
extends AbstractValve
implements OrderableValve

AbstractOrderableValve

This abstract class determines the valve name and other attributes by reading the properties of OrderableValve. e.g., OrderableValve.getValveName(), OrderableValve.getAfterValves(), OrderableValve.getBeforeValves(), etc.

Constructor Summary

Constructors

Constructor	Description
AbstractOrderableValve()

Method Summary

Modifier and Type	Method	Description
final String	getAfterValves()	Returns prerequisite valve names that should follow this valve.
final String	getBeforeValves()	Returns postrequisite valve names that should follow this valve.
final String	getValveName()	Returns the valve name.
final void	setAfterValves(String afterValves)	Sets prerequisite valve names that should follow this valve.
final void	setBeforeValves(String beforeValves)	Sets postrequisite valve names that should follow this valve.
final void	setValveName(String valveName)	Sets the valveName which can be used by other valves in setAfterValves(String) or setBeforeValves(String)

Methods inherited from class org.hippoecm.hst.container.valves.AbstractValve

destroy, initialize, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hippoecm.hst.core.container.Valve

destroy, initialize, invoke

Constructor Details

AbstractOrderableValve

public AbstractOrderableValve()

Method Details

getValveName

public final String getValveName()

Description copied from interface: OrderableValve

Returns the valve name.

Specified by:

getValveName in interface OrderableValve

Returns:

the valve name.

setValveName

public final void setValveName(String valveName)

Sets the valveName which can be used by other valves in setAfterValves(String) or setBeforeValves(String)

Parameters:

valveName - the name of the current valve

getBeforeValves

public final String getBeforeValves()

Description copied from interface: OrderableValve

Returns postrequisite valve names that should follow this valve. The return can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'

Specified by:

getBeforeValves in interface OrderableValve

Returns:

postrequisite valve names that should follow this valve.

setBeforeValves

public final void setBeforeValves(String beforeValves)

Sets postrequisite valve names that should follow this valve. The beforeValves can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'

Parameters:

beforeValves - the beforeValves for this AbstractOrderableValve. It can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'

getAfterValves

public final String getAfterValves()

Description copied from interface: OrderableValve

Returns prerequisite valve names that should follow this valve. The return can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'

Specified by:

getAfterValves in interface OrderableValve

Returns:

prerequisite valve names that should follow this valve.

setAfterValves

public final void setAfterValves(String afterValves)

Sets prerequisite valve names that should follow this valve. The after can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'

Parameters:

afterValves - the afterValves for this AbstractOrderableValve. It can have multiple valve names, separated by ' ', ',', '\t', '\r' or '\n'