|
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6.2) E26229-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SubstitutionHandler
Interface for handlers used by classes implementing Substitutor
(e.g., SubstitutorImpl
).
Substitutor
, SubstitutorImpl
Method Summary | |
---|---|
void |
close() Used to release any resources the handler may have claimed, such as open files or connections. |
boolean |
containsKey(java.lang.String name) Reports whether the handler can return a value to substitute for name . |
java.lang.String |
get(java.lang.String name) Returns the value which will be used to replace the token. |
java.lang.String |
getId() An identifier that can be used to request that a specific handler (or set of handlers) should be used for a substitution. |
Method Detail |
---|
java.lang.String getId()
The returned ID should adhere to basic identifier rules, e.g., it should consist of letters, numbers, and underscores only. A null, blank, or invalid ID may result in the handler being skipped.
The method getId()
may be called at any time.
boolean containsKey(java.lang.String name) throws SubstitutionException
name
. If containsKey
returns false
, then this handler will not be used for substituting name
.name
-true
if it can handle name
, false
otherwiseSubstitutionException
- if an error occurs accessing the keys.java.lang.String get(java.lang.String name) throws SubstitutionException
name
is not supported, then get()
should return null. Conversely, if the handler returns true
for containsKey(name)
, then get()
should return a non-null String.name
- The key value for the substitutionSubstitutionException
- if an error occurs accessing the value.void close()
|
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6.2) E26229-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |