パッケージ org.wcardinal.controller.internal

クラス Controller

java.lang.Object

org.wcardinal.controller.internal.Controller

すべての実装されたインタフェース:

ControllerContext, SContainerParent, SParent, MethodContainer, Unlockable

直系の既知のサブクラス:

ComponentController, RootController, VisibilityController

public class Controller
extends Object
implements ControllerContext, MethodContainer, SContainerParent

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
Controller(String name, Controller parent, ControllerFactory factory, Object instance, ControllerBaggage baggage, com.fasterxml.jackson.databind.node.ArrayNode factoryParameters, AutoCloseableReentrantLock lock, TaskInternalQueue tasks)

メソッドの概要

修飾子とタイプ	メソッド	説明
void	addParent(Controller parent)
boolean	cancel()	Cancels the current request issued by timeout or interval methods, or the current task.
boolean	cancel(long id)	Cancels the request of the specified ID issued by timeout or interval methods.
boolean	cancel(String reason)	Cancels the current task.
void	cancelAll()	Cancels all requests issued by timeout or interval methods.
Long	checkIdle(ControllerIo io)
protected Long	checkIdleNotRequired(ControllerIo io)
protected Long	checkIdleRequired(ControllerIo io)
void	checkVisibility()
void	create(Object... parameters)
void	destroy(Controller origin)
Future<?>	execute(Runnable runnable)	Requests to execute the specified runnable.
void	execute(String name, Object... parameters)	Requests to execute methods annotated with the OnTime of the specified name.
<T> Future<T>	execute(Callable<T> callable)	Requests to execute the specified callable.
<T> T	getActivePage()	Returns the active page or null.
ControllerAttributes	getAttributes()	Returns the attributes.
Controller	getControllerAt(String[] paths)
Controller	getControllerAt(String[] paths, int index, int length)
com.fasterxml.jackson.databind.node.ArrayNode	getFactoryParameters()	Returns the factory parameters.
Object	getInstance()
Locale	getLocale()	Returns the preferred locale.
List<Locale>	getLocales()	Returns the locale objects in decreasing order starting with the preferred locale.
String	getName()	Returns the name of this controller.
String	getParameter(String key)	Returns the first parameter of the specified key.
Map<String,String[]>	getParameterMap()	Returns the map of parameters.
String[]	getParameters(String key)	Returns the parameters of the specified key.
<T> T	getParent()	Returns the parent.
Factory<?>	getParentAsFactory()	Returns the parent as a factory.
<T> Collection<T>	getParents()	Returns the parents.
Principal	getPrincipal()	Returns the user principle.
String	getRemoteAddress()	Returns the user's remote address.
Long	getRequestId()
Scheduler	getScheduler()	Returns the scheduler.
String	getSessionId()	Returns the session ID.
StaticInfo	getStaticInfo()
StaticInstanceInfo	getStaticInstanceInfo()
String	getSubSessionId()	Returns the sub session ID.
TrackingIds	getTrackingIds()
<V> V	getWorkingData(Object key)
<T> void	handle(MethodResult<T> result)
boolean	hasHistorical()
boolean	hasOnIdleCheckMethods()
void	hide()	Hides this controller.
void	hide(String name)
long	interval(Runnable runnable, long interval)	Requests to call the specified runnable at the specified interval and returns an ID of this request.
long	interval(Runnable runnable, long startAt, long interval)	Requests to call the specified runnable at the specified interval after the 'startAfter' milliseconds and returns an ID of this request.
long	interval(String name, long interval)	Requests to call methods annotated with the OnTime of the specified name at the specified interval and returns an ID of this request.
long	interval(String name, long startAfter, long interval, Object... parameters)	Requests to call methods annotated with the OnTime of the specified name at the specified interval after the 'startAfter' milliseconds and returns an ID of this request.
boolean	isCanceled()	Returns true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing.
boolean	isHeadCall()	Returns true if the thread calling this method is the forefront executor of methods annotated with Tracked.
boolean	isHidden()	Returns true if this controller is hidden.
boolean	isHistorical()	Returns true if this controller is historical.
boolean	isLocked()	Returns true if this controller is locked.
boolean	isLockedByCurrentThread()	Returns true if this controller is locked by the current thread.
boolean	isNonNull()	Returns true if this controller is non-null.
boolean	isReadOnly()	Returns true if this controller is read-only.
boolean	isShared()
boolean	isShown()	Returns true if this controller is shown.
boolean	isShown(String name)
Unlocker	lock()	Locks this controller.
DynamicInfo	lockDynamicInfo(Controller origin, long senderId, long now, long timeout)
void	notify(String name, Object... parameters)	Requests to call methods annotated with the OnNotice of the specified name.
void	notifyAsync(String name, Object... parameters)	Requests to call methods annotated with the OnNotice of the specified name asynchronously.
void	onChange(String name, Object[] parameters)
void	onChange(SParent origin, SParent parent, String name, SChange schange)
void	onDestroy()
void	onHide()
void	onHide(String name)
void	onNotice(Object origin, String name, Object... parameters)
void	onShow()
void	onShow(String name)
void	onUnlock()
void	postCreate(Object... parameters)
void	put(Object origin, String name, SBase<?> sbase)
void	put(String name, SBase<?> sbase)
void	put(String name, ControllerOnChangeHandler handler)
void	put(ControllerDynamicInfoHandler handler)
void	putWorkingData(Object key, Object data)
void	setAuthorizedRevision(Controller origin, AckInfo info, boolean allowCompaction)
void	setRequestId(Long id)
void	setTrackingIds(TrackingIds ids)
void	show()	Shows this controller.
void	show(String name)
long	timeout(Runnable runnable, long delay)	Requests to call the specified runnable after the specified delay and returns an ID of this request.
long	timeout(String name, long delay, Object... parameters)	Requests to call methods annotated with the OnTime of the specified name after the specified delay and returns an ID of this request.
<T> TimeoutFuture<T>	timeout(Callable<T> callable, long delay)	Requests to call the specified callable after the specified delay.
void	trigger(String name, Object... arguments)	Triggers the event of the given name at browsers.
TriggerResult	triggerAndWait(String name, long timeout, Object... arguments)	Triggers the event of the specified name at browsers and waits for responses from browsers.
void	triggerDirect(String name, Object... arguments)	Triggers the event of the given name at browsers directly.
boolean	tryLock()	Tries to lock this controller.
boolean	tryLock(long timeout, TimeUnit unit)	Tries to lock this controller.
void	unlock()	Unlocks this controller.
void	unlock(Controller origin)
void	unlockDynamicInfo(Controller origin, long senderId, long now)
void	update()

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

Controller

public Controller(String name,
 Controller parent,
 ControllerFactory factory,
 Object instance,
 ControllerBaggage baggage,
 com.fasterxml.jackson.databind.node.ArrayNode factoryParameters,
 AutoCloseableReentrantLock lock,
 TaskInternalQueue tasks)

メソッドの詳細

handle

public <T> void handle(MethodResult<T> result)

定義:

handle インタフェース内 MethodContainer

addParent

public void addParent(Controller parent)

setAuthorizedRevision

public void setAuthorizedRevision(Controller origin,
 AckInfo info,
 boolean allowCompaction)

lockDynamicInfo

public DynamicInfo lockDynamicInfo(Controller origin,
 long senderId,
 long now,
 long timeout)

unlockDynamicInfo

public void unlockDynamicInfo(Controller origin,
 long senderId,
 long now)

lock

public Unlocker lock()

インタフェースからコピーされた説明: ControllerContext

Locks this controller.

Please note that all the fields and controllers belonging to the same controller instance share a lock. Thus, the followings is not necessary:

 @Controller
 class MyController {
   @Autowired
   SString name;

   @Autowired
   SInteger score;

   @OnChange("name")
   void onChange(){
     try( Unlocker unlocker = score.lock() ){ // Unnecessary
       score.set( 0 );
     }
   }
 }
 

When the 'onChange' method is called, the 'name' field is locked. And the 'name' field, the 'score' field and the 'MyController' controller share a lock. The 'score' field, therefore, is locked at the time the 'onChange' method is called. The only exception to this is a component annotated with SharedComponent. Shared components and fields on them do not share a lock with the others. Because shared components do not share a lock, the lock ordering is necessary to avoid concurrency issues. If locking a shared component and one of its parents at once is unavoidable, must lock a parent at first. And then lock a shared component.

 @SharedComponent
 class MySharedComponent{}

 @Controller
 class MyController {
   @Autowired
   MySharedComponent component;

   void foo(){
     // At first lock itself, the parent of the 'this.component'
     try( Unlocker parent = lock() ) {
       // Then lock a shared component
       try( Unlocker child = component.lock() ) {
         // Do something here
       }
     }
   }
 }
 

定義:

lock インタフェース内 ControllerContext

定義:

lock インタフェース内 MethodContainer

定義:

lock インタフェース内 SContainerParent

戻り値:

Unlocker instance for unlocking this lock

tryLock

public boolean tryLock()

インタフェースからコピーされた説明: ControllerContext

Tries to lock this controller.

定義:

tryLock インタフェース内 ControllerContext

定義:

tryLock インタフェース内 SContainerParent

戻り値:

true if succeeded

tryLock

public boolean tryLock(long timeout,
 TimeUnit unit)

インタフェースからコピーされた説明: ControllerContext

Tries to lock this controller.

定義:

tryLock インタフェース内 ControllerContext

定義:

tryLock インタフェース内 SContainerParent

パラメータ:

timeout - the timeout for this trial

unit - the unit of the timeout

戻り値:

true if succeeded

isLocked

public boolean isLocked()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is locked.

定義:

isLocked インタフェース内 ControllerContext

定義:

isLocked インタフェース内 SContainerParent

戻り値:

true if this controller is locked.

isLockedByCurrentThread

public boolean isLockedByCurrentThread()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is locked by the current thread.

定義:

isLockedByCurrentThread インタフェース内 ControllerContext

定義:

isLockedByCurrentThread インタフェース内 MethodContainer

定義:

isLockedByCurrentThread インタフェース内 SContainerParent

戻り値:

true if this controller is locked by the current thread.

unlock

public void unlock()

インタフェースからコピーされた説明: ControllerContext

Unlocks this controller.

定義:

unlock インタフェース内 ControllerContext

定義:

unlock インタフェース内 MethodContainer

定義:

unlock インタフェース内 SContainerParent

定義:

unlock インタフェース内 Unlockable

unlock

public void unlock(Controller origin)

onUnlock

public void onUnlock()

定義:

onUnlock インタフェース内 SParent

update

public void update()

定義:

update インタフェース内 SParent

getName

public String getName()

インタフェースからコピーされた説明: ControllerContext

Returns the name of this controller.

定義:

getName インタフェース内 ControllerContext

戻り値:

the name of this controller

getParent

public <T> T getParent()

インタフェースからコピーされた説明: ControllerContext

Returns the parent.

定義:

getParent インタフェース内 ControllerContext

型パラメータ:

T - the type of parent

戻り値:

the parent instance

getParents

public <T> Collection<T> getParents()

インタフェースからコピーされた説明: ControllerContext

Returns the parents.

定義:

getParents インタフェース内 ControllerContext

型パラメータ:

T - the type of parents

戻り値:

the parent instances

getParentAsFactory

public Factory<?> getParentAsFactory()

インタフェースからコピーされた説明: ControllerContext

Returns the parent as a factory.

定義:

getParentAsFactory インタフェース内 ControllerContext

戻り値:

the parent instance

getActivePage

public <T> T getActivePage()

インタフェースからコピーされた説明: ControllerContext

Returns the active page or null.

定義:

getActivePage インタフェース内 ControllerContext

型パラメータ:

T - the type of the active page

戻り値:

the active page

getInstance

public Object getInstance()

getParameter

public String getParameter(String key)

インタフェースからコピーされた説明: ControllerContext

Returns the first parameter of the specified key. The parameters are taken from the query string or posted form data.

 // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
      System.out.println( getParameter("name") ); // prints "Cardinal"
   }
 }
 

定義:

getParameter インタフェース内 ControllerContext

パラメータ:

key - the key of the parameter

戻り値:

the first parameter of the specified key

getParameters

public String[] getParameters(String key)

インタフェースからコピーされた説明: ControllerContext

Returns the parameters of the specified key. The parameters are taken from the query string or posted form data.

 // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
     System.out.println( Arrays.toString(getParameters("name")) ); // prints ["Cardinal"]
   }
 }
 

定義:

getParameters インタフェース内 ControllerContext

パラメータ:

key - the key of the parameters

戻り値:

the parameters of the specified key

getParameterMap

public Map<String,String[]> getParameterMap()

インタフェースからコピーされた説明: ControllerContext

Returns the map of parameters. The parameters are taken from the query string or posted form data.

 // HTML
 <script src="my-controller?name=Cardinal"></script>

 // Java
 @Controller
 class MyController {
   @OnCreate
   void onCreate(){
     System.out.println( getParameterMap("name") ); // prints {name=["Cardinal"]}
   }
 }
 

定義:

getParameterMap インタフェース内 ControllerContext

戻り値:

the map of parameters

getFactoryParameters

public com.fasterxml.jackson.databind.node.ArrayNode getFactoryParameters()

インタフェースからコピーされた説明: ControllerContext

Returns the factory parameters. The factory parameters are the parameters given to the method Factory.create(Object...).

 @Controller
 class MyController {
   @Autowired
   ComponentFactory<MyComponent> factory;

   @OnCreate
   void onCreate(){
     factory.create(1, "Cardinal");
   }
 }

 class MyComponent extends AbstractComponent {
   @OnCreate
   void onCreate(){
     System.out.println( getFactoryParameters() ); // prints [1, "Cardinal"]
   }
 }
 

定義:

getFactoryParameters インタフェース内 ControllerContext

戻り値:

the factory parameters.

getAttributes

public ControllerAttributes getAttributes()

インタフェースからコピーされた説明: ControllerContext

Returns the attributes.

定義:

getAttributes インタフェース内 ControllerContext

戻り値:

the attributes.

put

public void put(String name,
 SBase<?> sbase)

put

public void put(Object origin,
 String name,
 SBase<?> sbase)

定義:

put インタフェース内 SContainerParent

put

public void put(String name,
 ControllerOnChangeHandler handler)

put

public void put(ControllerDynamicInfoHandler handler)

定義:

put インタフェース内 SContainerParent

create

public void create(Object... parameters)

postCreate

public void postCreate(Object... parameters)

checkVisibility

public void checkVisibility()

onChange

public void onChange(SParent origin,
 SParent parent,
 String name,
 SChange schange)

定義:

onChange インタフェース内 SParent

onChange

public void onChange(String name,
 Object[] parameters)

onNotice

public void onNotice(Object origin,
 String name,
 Object... parameters)

show

public void show()

インタフェースからコピーされた説明: ControllerContext

Shows this controller.

定義:

show インタフェース内 ControllerContext

hide

public void hide()

インタフェースからコピーされた説明: ControllerContext

Hides this controller.

定義:

hide インタフェース内 ControllerContext

isShown

public boolean isShown()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is shown.

定義:

isShown インタフェース内 ControllerContext

戻り値:

true if this controller is shown.

isHidden

public boolean isHidden()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is hidden.

定義:

isHidden インタフェース内 ControllerContext

戻り値:

true if this controller is hidden.

onShow

public void onShow(String name)

onShow

public void onShow()

onHide

public void onHide(String name)

onHide

public void onHide()

onDestroy

public void onDestroy()

destroy

public void destroy(Controller origin)

getStaticInfo

public StaticInfo getStaticInfo()

hasHistorical

public boolean hasHistorical()

getStaticInstanceInfo

public StaticInstanceInfo getStaticInstanceInfo()

getRemoteAddress

public String getRemoteAddress()

インタフェースからコピーされた説明: ControllerContext

Returns the user's remote address.

定義:

getRemoteAddress インタフェース内 ControllerContext

戻り値:

user's remote address

getPrincipal

public Principal getPrincipal()

インタフェースからコピーされた説明: ControllerContext

Returns the user principle.

定義:

getPrincipal インタフェース内 ControllerContext

戻り値:

user principle

getScheduler

public Scheduler getScheduler()

インタフェースからコピーされた説明: ControllerContext

Returns the scheduler.

定義:

getScheduler インタフェース内 ControllerContext

定義:

getScheduler インタフェース内 MethodContainer

戻り値:

the scheduler

getSessionId

public String getSessionId()

インタフェースからコピーされた説明: ControllerContext

Returns the session ID.

定義:

getSessionId インタフェース内 ControllerContext

戻り値:

the session ID

getSubSessionId

public String getSubSessionId()

インタフェースからコピーされた説明: ControllerContext

Returns the sub session ID.

定義:

getSubSessionId インタフェース内 ControllerContext

戻り値:

the sub session ID

execute

public void execute(String name,
 Object... parameters)

インタフェースからコピーされた説明: ControllerContext

Requests to execute methods annotated with the OnTime of the specified name.

定義:

execute インタフェース内 ControllerContext

パラメータ:

name - method name specified by OnTime

parameters - parameters to be passed to the specified methods

execute

public Future<?> execute(Runnable runnable)

インタフェースからコピーされた説明: ControllerContext

Requests to execute the specified runnable.

定義:

execute インタフェース内 ControllerContext

パラメータ:

runnable - runnable to be executed

戻り値:

future

execute

public <T> Future<T> execute(Callable<T> callable)

インタフェースからコピーされた説明: ControllerContext

Requests to execute the specified callable.

定義:

execute インタフェース内 ControllerContext

型パラメータ:

T - return type of the specified callable

パラメータ:

callable - callable to be executed

戻り値:

future

timeout

public long timeout(String name,
 long delay,
 Object... parameters)

インタフェースからコピーされた説明: ControllerContext

Requests to call methods annotated with the OnTime of the specified name after the specified delay and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long) for canceling the request.

定義:

timeout インタフェース内 ControllerContext

パラメータ:

name - method name specified by OnTime

delay - delay in milliseconds

parameters - parameters to be passed to the specified methods

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

timeout

public long timeout(Runnable runnable,
 long delay)

インタフェースからコピーされた説明: ControllerContext

Requests to call the specified runnable after the specified delay and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long) for canceling the request.

定義:

timeout インタフェース内 ControllerContext

パラメータ:

runnable - runnable to be executed

delay - delay in milliseconds

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

timeout

public <T> TimeoutFuture<T> timeout(Callable<T> callable,
 long delay)

インタフェースからコピーされた説明: ControllerContext

Requests to call the specified callable after the specified delay. Use the returned ID and ControllerContext.cancel(long) for canceling the request.

定義:

timeout インタフェース内 ControllerContext

型パラメータ:

T - return type of the specified callable

パラメータ:

callable - callable to be executed

delay - delay in milliseconds

戻り値:

future

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

interval

public long interval(String name,
 long interval)

インタフェースからコピーされた説明: ControllerContext

Requests to call methods annotated with the OnTime of the specified name at the specified interval and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long), or ControllerContext.cancel() for canceling the request. The first call is taking place after the milliseconds specified as the interval.

定義:

interval インタフェース内 ControllerContext

パラメータ:

name - method name specified by OnTime

interval - interval in milliseconds

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

interval

public long interval(String name,
 long startAfter,
 long interval,
 Object... parameters)

インタフェースからコピーされた説明: ControllerContext

Requests to call methods annotated with the OnTime of the specified name at the specified interval after the 'startAfter' milliseconds and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long), or ControllerContext.cancel() for canceling the request. The first call is taking place after the 'startAfter' milliseconds.

定義:

interval インタフェース内 ControllerContext

パラメータ:

name - method name specified by OnTime

startAfter - delay of the first call in milliseconds

interval - interval in milliseconds

parameters - parameters to be passed to the specified methods

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

interval

public long interval(Runnable runnable,
 long interval)

インタフェースからコピーされた説明: ControllerContext

Requests to call the specified runnable at the specified interval and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long), or ControllerContext.cancel() for canceling the request. The first call is taking place after the milliseconds specified as the interval.

定義:

interval インタフェース内 ControllerContext

パラメータ:

runnable - runnable to be executed

interval - interval in milliseconds

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

interval

public long interval(Runnable runnable,
 long startAt,
 long interval)

インタフェースからコピーされた説明: ControllerContext

Requests to call the specified runnable at the specified interval after the 'startAfter' milliseconds and returns an ID of this request. Use the returned ID and ControllerContext.cancel(long), or ControllerContext.cancel() for canceling the request. The first call is taking place after the 'startAfter' milliseconds.

定義:

interval インタフェース内 ControllerContext

パラメータ:

runnable - runnable to be executed

startAt - delay of the first call in milliseconds

interval - interval in milliseconds

戻り値:

request ID

関連項目:

• ControllerContext.cancel()
• ControllerContext.cancel(long)
• ControllerContext.cancelAll()

cancel

public boolean cancel(long id)

インタフェースからコピーされた説明: ControllerContext

Cancels the request of the specified ID issued by timeout or interval methods.

定義:

cancel インタフェース内 ControllerContext

パラメータ:

id - request ID

戻り値:

true if succeeded

関連項目:

• ControllerContext.timeout(String, long, Object...)
• ControllerContext.timeout(Runnable, long)
• ControllerContext.timeout(Callable, long)
• ControllerContext.interval(String, long)
• ControllerContext.interval(String, long, long, Object...)
• ControllerContext.interval(Runnable, long)
• ControllerContext.interval(Runnable, long, long)

getRequestId

public Long getRequestId()

定義:

getRequestId インタフェース内 MethodContainer

setRequestId

public void setRequestId(Long id)

定義:

setRequestId インタフェース内 MethodContainer

getTrackingIds

public TrackingIds getTrackingIds()

定義:

getTrackingIds インタフェース内 MethodContainer

setTrackingIds

public void setTrackingIds(TrackingIds ids)

定義:

setTrackingIds インタフェース内 MethodContainer

cancel

public boolean cancel()

インタフェースからコピーされた説明: ControllerContext

Cancels the current request issued by timeout or interval methods, or the current task. Under the hood, a thread local is used to distinguish requests/tasks.

 @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     interval( "update", 1000 );
   }

   @OnTime
   void update(){
     // Stops the "update" by itself
     cancel();
   }
 }
 

定義:

cancel インタフェース内 ControllerContext

戻り値:

true if succeeded

関連項目:

• ControllerContext.timeout(String, long, Object...)
• ControllerContext.timeout(Runnable, long)
• ControllerContext.timeout(Callable, long)
• ControllerContext.interval(String, long)
• ControllerContext.interval(String, long, long, Object...)
• ControllerContext.interval(Runnable, long)
• ControllerContext.interval(Runnable, long, long)

cancel

public boolean cancel(String reason)

インタフェースからコピーされた説明: ControllerContext

Cancels the current task. Under the hood, a thread local is used to distinguish tasks.

定義:

cancel インタフェース内 ControllerContext

パラメータ:

reason - a cancel reason

戻り値:

true if succeeded

cancelAll

public void cancelAll()

インタフェースからコピーされた説明: ControllerContext

Cancels all requests issued by timeout or interval methods.

定義:

cancelAll インタフェース内 ControllerContext

関連項目:

• ControllerContext.timeout(String, long, Object...)
• ControllerContext.timeout(Runnable, long)
• ControllerContext.timeout(Callable, long)
• ControllerContext.interval(String, long)
• ControllerContext.interval(String, long, long, Object...)
• ControllerContext.interval(Runnable, long)
• ControllerContext.interval(Runnable, long, long)

isCanceled

public boolean isCanceled()

インタフェースからコピーされた説明: ControllerContext

Returns true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing. Under the hood, a thread local is used to distinguish requests/tasks

定義:

isCanceled インタフェース内 ControllerContext

戻り値:

true if the current task is canceled or if the current request issued by timeout or interval methods is canceled/non-existing

isHeadCall

public boolean isHeadCall()

インタフェースからコピーされた説明: ControllerContext

Returns true if the thread calling this method is the forefront executor of methods annotated with Tracked.

定義:

isHeadCall インタフェース内 ControllerContext

戻り値:

true if the thread calling this method is the forefront executor of methods annotated with Tracked

trigger

public void trigger(String name,
 Object... arguments)

インタフェースからコピーされた説明: ControllerContext

Triggers the event of the given name at browsers. Optional arguments are passed to browsers as event data.

 // JavaScript
 myController.on( 'hello', function( e, name ){
   console.log( name ); // prints 'Cardinal'
 });

 // Java
 @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     timeout( "hello", 5000 );
   }

   @OnTime
   void hello(){
     trigger( "hello", "Cardinal" );
   }
 }
 

定義:

trigger インタフェース内 ControllerContext

パラメータ:

name - event name

arguments - event data

関連項目:

• ControllerContext.triggerAndWait(String, long, Object...)
• ControllerContext.triggerDirect(String, Object...)

triggerDirect

public void triggerDirect(String name,
 Object... arguments)

インタフェースからコピーされた説明: ControllerContext

Triggers the event of the given name at browsers directly. Only difference between ControllerContext.trigger(String, Object...) and this is this method sends trigger events directly by bypassing the most of the costly synchronization processes. Thus, in general, supposed to be faster than ControllerContext.trigger(String, Object...). However, because of this, weak against network disconnections.

定義:

triggerDirect インタフェース内 ControllerContext

パラメータ:

name - event name

arguments - event data

関連項目:

• ControllerContext.trigger(String, Object...)
• ControllerContext.triggerAndWait(String, long, Object...)

triggerAndWait

public TriggerResult triggerAndWait(String name,
 long timeout,
 Object... arguments)

インタフェースからコピーされた説明: ControllerContext

Triggers the event of the specified name at browsers and waits for responses from browsers. Optional arguments are passed to browsers as event data. When a browser send back responses within a given period of time, the callback DoneCallback set to the Promise.done(org.jdeferred.DoneCallback) is called. Otherwise, the callback FailCallback set to the Promise.fail(org.jdeferred.FailCallback) is called.

 // JavaScript
 myController.on( 'hello', function( e, name ){
   console.log( name ); // prints 'Cardinal'
   return 'Hello, '+name;
 });

 // Java
 @Controller
 class MyController extends AbstractController {
   @OnCreate
   void onCreate(){
     timeout( "hello", 5000 );
   }

   @OnTime
   void hello(){
     trigger( "hello", 3000, "Cardinal" )
     .done(new DoneCallback<List<JsonNode>>(){
       public void onDone(List<JsonNode> result) {
         System.out.println( result.get( 0 ).asText() ); // prints "Hello, Cardinal"
       }
     });
   }
 }
 

定義:

triggerAndWait インタフェース内 ControllerContext

パラメータ:

name - event name

timeout - timeout for this trigger in milliseconds

arguments - event data

戻り値:

promise instance

関連項目:

• ControllerContext.trigger(String, Object...)
• ControllerContext.triggerDirect(String, Object...)

show

public void show(String name)

hide

public void hide(String name)

isShown

public boolean isShown(String name)

isReadOnly

public boolean isReadOnly()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is read-only.

定義:

isReadOnly インタフェース内 ControllerContext

戻り値:

true if this controller is read-only.

isNonNull

public boolean isNonNull()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is non-null.

定義:

isNonNull インタフェース内 ControllerContext

戻り値:

true if this controller is non-null.

isHistorical

public boolean isHistorical()

インタフェースからコピーされた説明: ControllerContext

Returns true if this controller is historical.

定義:

isHistorical インタフェース内 ControllerContext

戻り値:

true if this controller is historical.

isShared

public boolean isShared()

定義:

isShared インタフェース内 SContainerParent

getLocales

public List<Locale> getLocales()

インタフェースからコピーされた説明: ControllerContext

Returns the locale objects in decreasing order starting with the preferred locale.

定義:

getLocales インタフェース内 ControllerContext

戻り値:

the locale objects

getLocale

public Locale getLocale()

インタフェースからコピーされた説明: ControllerContext

Returns the preferred locale.

定義:

getLocale インタフェース内 ControllerContext

戻り値:

the preferred locale

notify

public void notify(String name,
 Object... parameters)

インタフェースからコピーされた説明: ControllerContext

Requests to call methods annotated with the OnNotice of the specified name. Notifications propagate to parents. To catch a notification triggered by a child, use a name prefixed with a child name.

 @Component
 class MyComponent extends AbstractComponent {
   void notifyBar(){
     notify( "bar" );
   }
 }

 @Controller
 class MyController {
   @Autowired
   MyComponent foo;

   @OnNotice("foo.bar")
   void onNotice(){
     // Called when the child 'foo' sends a 'bar' notification
   }
 }
 

定義:

notify インタフェース内 ControllerContext

パラメータ:

name - notification name

parameters - notification parameters

関連項目:

• ControllerContext.notifyAsync(String, Object...)

notifyAsync

public void notifyAsync(String name,
 Object... parameters)

インタフェースからコピーされた説明: ControllerContext

Requests to call methods annotated with the OnNotice of the specified name asynchronously. Notifications propagate to parents. To catch a notification triggered by a child, use a name prefixed with a child name.

 @Component
 class MyComponent extends AbstractComponent {
   void notifyBar(){
     notifyAsync( "bar" );
   }
 }

 @Controller
 class MyController {
   @Autowired
   MyComponent foo;

   @OnNotice("foo.bar")
   void onNotice(){
     // Called when the child 'foo' sends a 'bar' notification
   }
 }
 

定義:

notifyAsync インタフェース内 ControllerContext

パラメータ:

name - notification name

parameters - notification parameters

関連項目:

• ControllerContext.notify(String, Object...)

getWorkingData

public <V> V getWorkingData(Object key)

定義:

getWorkingData インタフェース内 MethodContainer

putWorkingData

public void putWorkingData(Object key,
 Object data)

定義:

putWorkingData インタフェース内 MethodContainer

getControllerAt

public Controller getControllerAt(String[] paths)

getControllerAt

public Controller getControllerAt(String[] paths,
 int index,
 int length)

hasOnIdleCheckMethods

public boolean hasOnIdleCheckMethods()

checkIdle

public Long checkIdle(ControllerIo io)

checkIdleNotRequired

protected Long checkIdleNotRequired(ControllerIo io)

checkIdleRequired

protected Long checkIdleRequired(ControllerIo io)