Package com.microstrategy.web.transform
Class FormalParameterAnnotation
- java.lang.Object
-
- com.microstrategy.web.transform.FormalParameterAnnotation
-
public class FormalParameterAnnotation extends java.lang.Object
- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static FormalParameterAnnotation
DEPRECATED
static FormalParameterAnnotation
IGNORED
static FormalParameterAnnotation
NOT_USED
Instead of marking a FormalParameter as NOT_USED, consider removing it withAbstractTransform.removeFormalParam(String)
orFormalParametersImpl.removeFormalParameter(int)
.static FormalParameterAnnotation
UNCLASSIFIED
static FormalParameterAnnotation
USABLE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FormalParameterAnnotation
create(FormalParameterAnnotation prototype, java.lang.String desc)
This factory method is for creating annotations with descriptions.boolean
equals(java.lang.Object obj)
java.lang.String
getDescription()
static FormalParameters
getVisibleParameters(FormalParameters fps)
int
hashCode()
boolean
isVisible()
java.lang.String
toString()
-
-
-
Field Detail
-
USABLE
public static final FormalParameterAnnotation USABLE
-
DEPRECATED
public static final FormalParameterAnnotation DEPRECATED
-
NOT_USED
public static final FormalParameterAnnotation NOT_USED
Instead of marking a FormalParameter as NOT_USED, consider removing it withAbstractTransform.removeFormalParam(String)
orFormalParametersImpl.removeFormalParameter(int)
.
-
IGNORED
public static final FormalParameterAnnotation IGNORED
-
UNCLASSIFIED
public static final FormalParameterAnnotation UNCLASSIFIED
-
-
Method Detail
-
create
public static FormalParameterAnnotation create(FormalParameterAnnotation prototype, java.lang.String desc)
This factory method is for creating annotations with descriptions.- Parameters:
prototype
- determines annotation typedesc
- annotation details- Returns:
- the annotation
-
getDescription
public java.lang.String getDescription()
-
isVisible
public boolean isVisible()
- Returns:
- whether the annotation is USABLE or DEPRECATED
-
getVisibleParameters
public static FormalParameters getVisibleParameters(FormalParameters fps)
- Returns:
- FormalParameters that are annotated USED or DEPRECATED
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-