Class MethodInfoBuilder.BuiltMethodInfo

    • Field Detail

      • _name

        private final java.lang.String _name
      • _signature

        private final java.lang.String _signature
      • _returnType

        private final IType _returnType
      • _exceptions

        private final java.util.List<IExceptionInfo> _exceptions
      • _deprecated

        private final java.lang.String _deprecated
      • _isStatic

        private final boolean _isStatic
      • _description

        private final java.lang.String _description
      • _returnDescription

        private final java.lang.String _returnDescription
      • _hidden

        private final boolean _hidden
    • Method Detail

      • getDefaultValueExpressions

        public IExpression[] getDefaultValueExpressions()
        Specified by:
        getDefaultValueExpressions in interface IOptionalParamCapable
        Returns:
        An array of objects representing the default values for a function's parameters. Returns an empty array if there are no default values, otherwise returns an array corresponding with default parameter values. If a parameter does not have a default value, it's default value is null in the array.
      • getDeprecatedReason

        public java.lang.String getDeprecatedReason()
        Specified by:
        getDeprecatedReason in interface IAnnotatedFeatureInfo
        Returns:
        The deprecation message, or null if the feature is not deprecated.
      • isDefaultImpl

        public boolean isDefaultImpl()
        Specified by:
        isDefaultImpl in interface IAnnotatedFeatureInfo
        Returns:
        True if this feature is the default implementation e.g., default interface method
      • isVisible

        public boolean isVisible​(IScriptabilityModifier constraint)
        Description copied from interface: IAttributedFeatureInfo
        Determine if this feature is visible given a visibility constraint.

        NOTE: implementers of this method are responsible for handling the null case, taken to mean that there are not scriptability constraints.

        Specified by:
        isVisible in interface IAttributedFeatureInfo
      • isStatic

        public boolean isStatic()
        Description copied from interface: IAttributedFeatureInfo
        True if this feature is static, meaning the feature is not specific to a particular instance of the feature's containing type.
        Specified by:
        isStatic in interface IAttributedFeatureInfo
      • isPrivate

        public boolean isPrivate()
        Description copied from interface: IAttributedFeatureInfo
        True if this feature is private. Private features are only accessible from within the type that owns them.
        Specified by:
        isPrivate in interface IAttributedFeatureInfo
      • isInternal

        public boolean isInternal()
        Description copied from interface: IAttributedFeatureInfo
        True if this feature is internal. Internal features are accessible from within the type that owns them and from other types in the same namespace.
        Specified by:
        isInternal in interface IAttributedFeatureInfo
      • isProtected

        public boolean isProtected()
        Description copied from interface: IAttributedFeatureInfo
        True if this feature is protected. Protected features are accessible from within the type that owns them and from derived containers.
        Specified by:
        isProtected in interface IAttributedFeatureInfo
      • getAnnotations

        public java.util.List<IAnnotationInfo> getAnnotations()
        Specified by:
        getAnnotations in interface IAnnotatedFeatureInfo
        Returns:
        A map of AnnotationInfo objects by type representing all the annotations associated with this feature and all the features in its ancestry, or an empty map if there are no annotations.
      • getDeclaredAnnotations

        public java.util.List<IAnnotationInfo> getDeclaredAnnotations()
        Specified by:
        getDeclaredAnnotations in interface IAnnotatedFeatureInfo
        Returns:
        A map of AnnotationInfo objects by type representing all the annotations associated with this feature, or an empty map if there are no annotations.
      • hasDeclaredAnnotation

        public boolean hasDeclaredAnnotation​(IType type)
        Specified by:
        hasDeclaredAnnotation in interface IAnnotatedFeatureInfo
        Parameters:
        type - The type of the annotation to test for existence.
        Returns:
        true If this feature has a declared annotation of the given type, false otherwise
      • hasAnnotation

        public boolean hasAnnotation​(IType type)
        Specified by:
        hasAnnotation in interface IAnnotatedFeatureInfo
        Parameters:
        type - The type of the annotation to test for existence.
        Returns:
        true If this feature has an annotation with of the given type, false otherwise
      • getOwnersType

        public IType getOwnersType()
        Description copied from interface: IFeatureInfo
        Get this feature's owner's type. If this feature has no owner, this is the type of the feature itself. Typically, the only kind of feature w/o an owner is an ITypeInfo, so properties, methods, params, etc. s/b considered owned. Hence, ultimately an ITypeInfo's type will be the owner's type for any given feature.
        Specified by:
        getOwnersType in interface IFeatureInfo
      • getName

        public java.lang.String getName()
        Description copied from interface: IFeatureInfo
        Gets the programmatic name or identifier of this feature. Note this name should follow Java identifier naming conventions (alpha-num and underscores, but can't start with a digit).
        Specified by:
        getName in interface IFeatureInfo
        Specified by:
        getName in interface IMethodInfo
      • makeSignature

        private java.lang.String makeSignature()
      • getDisplayName

        public java.lang.String getDisplayName()
        Description copied from interface: IFeatureInfo
        Gets the display name of this feature. There is no guarantee this display name is localized.
        Specified by:
        getDisplayName in interface IFeatureInfo
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: IFeatureInfo
        A full description of this feature.
        Specified by:
        getDescription in interface IFeatureInfo
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object