ControllerComponent

java.lang.Object

com.blackrook.small.SmallComponent

com.blackrook.small.dispatch.DispatchComponent

com.blackrook.small.dispatch.controller.ControllerComponent

public class ControllerComponent extends DispatchComponent

Creates a controller profile to assist in re-calling controllers by path and methods.

Author:: Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

ControllerComponent.Output

Controller output handling types.
Field Summary

Fields

Modifier and Type

Field

Description

protected static final Class<?>[]

NO_FILTERS
Constructor Summary

Constructors

Constructor

Description

ControllerComponent(Object instance)

Creates the controller profile for a Controller class.
Method Summary

Modifier and Type

Method

Description

List<ControllerEntryPoint>

getEntryMethods()

Class<?>[]

getFilterChain()

String

getPath()

protected void

scanMethod(Method method)

Called to handle a single method scan for this component type.

Methods inherited from class com.blackrook.small.dispatch.DispatchComponent
getAttributeConstructor, getModelConstructor, getPartData

Methods inherited from class com.blackrook.small.SmallComponent
getInstance, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- NO_FILTERS
  
  protected static final Class<?>[] NO_FILTERS
Constructor Details
- ControllerComponent
  
  public ControllerComponent(Object instance)
  
  Creates the controller profile for a Controller class.
  
  Parameters:
  
  instance - the input class to profile.
  
  Throws:
  
  SmallFrameworkException - if this profile cannot be created due to an initialization problem.
Method Details
- getPath
  
  public String getPath()
  
  Returns:
  
  the base path for this controller.
- getFilterChain
  
  public Class<?>[] getFilterChain()
  
  Returns:
  
  the list of filter classes to call.
- getEntryMethods
  
  public List<ControllerEntryPoint> getEntryMethods()
  
  Returns:
  
  the entry points on this controller.
- scanMethod
  
  protected void scanMethod(Method method)
  
  Description copied from class: SmallComponent
  
  Called to handle a single method scan for this component type. If this method is overridden, it would be wise to call super.scanMethod(m).
  
  Overrides:
  
  scanMethod in class DispatchComponent
  
  Parameters:
  
  method - the method to inspect.