2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "fi" >
< head >
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
< title > Conditional (Plan 5.1-SNAPSHOT API)< / title >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-03-21 15:43:05 +01:00
parent.document.title="Conditional (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a name = "navbar.top" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.top.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../../com/djrapitops/plan/extension/annotation/BooleanProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/extension/annotation/DoubleProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/djrapitops/plan/extension/annotation/Conditional.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Conditional.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Field | < / li >
< li > < a href = "#annotation.type.required.element.summary" > Required< / a > | < / li >
< li > < a href = "#annotation.type.optional.element.summary" > Optional< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#annotation.type.element.detail" > Element< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.top" >
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
< div class = "subTitle" > com.djrapitops.plan.extension.annotation< / div >
< h2 title = "Annotation Type Conditional" class = "title" > Annotation Type Conditional< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< br >
< pre > @Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface < span class = "memberNameLabel" > Conditional< / span > < / pre >
< div class = "block" > Method Annotation to determine that a method can not be called unless a condition is fulfilled.
< p >
Condition information is provided with < a href = "../../../../../com/djrapitops/plan/extension/annotation/BooleanProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < code > BooleanProvider< / code > < / a > .
If < a href = "../../../../../com/djrapitops/plan/extension/annotation/BooleanProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < code > BooleanProvider< / code > < / a > for the condition is not specified the
2019-10-05 10:27:37 +02:00
method tagged with this annotation will not be called, (Condition is assumed false).
Please note that Conditional does not cross method parameter boundaries - (Conditional on a player method does not
take into account conditionals of server).< / div >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "annotation.type.required.element.summary" >
<!-- -->
< / a >
< h3 > Required Element Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Required Element Summary table, listing required elements, and an explanation" >
< caption > < span > Required Elements< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Required Element and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/extension/annotation/Conditional.html#value--" > value< / a > < / span > < / code >
< div class = "block" > Name of the condition limited to 50 characters.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "annotation.type.optional.element.summary" >
<!-- -->
< / a >
< h3 > Optional Element Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Optional Element Summary table, listing optional elements, and an explanation" >
< caption > < span > Optional Elements< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Optional Element and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/extension/annotation/Conditional.html#negated--" > negated< / a > < / span > < / code >
< div class = "block" > Reverse the condition.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "annotation.type.element.detail" >
<!-- -->
< / a >
< h3 > Element Detail< / h3 >
< a name = "value--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > value< / h4 >
< pre > public abstract java.lang.String value< / pre >
< div class = "block" > Name of the condition limited to 50 characters.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Case sensitive string of max 50 characters.< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "negated--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > negated< / h4 >
< pre > public abstract boolean negated< / pre >
< div class = "block" > Reverse the condition.
< p >
Example:
- Method with < code > Conditional("expires", negated = true)< / code > will only be called when the condition "expires" is false.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > < code > false< / code > by default.< / dd >
< / dl >
< dl >
< dt > Default:< / dt >
< dd > false< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar.bottom" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.bottom.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../../com/djrapitops/plan/extension/annotation/BooleanProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/extension/annotation/DoubleProvider.html" title = "annotation in com.djrapitops.plan.extension.annotation" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/djrapitops/plan/extension/annotation/Conditional.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Conditional.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Field | < / li >
< li > < a href = "#annotation.type.required.element.summary" > Required< / a > | < / li >
< li > < a href = "#annotation.type.optional.element.summary" > Optional< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#annotation.type.element.detail" > Element< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
