Class IndexTypeInfo

  • All Implemented Interfaces:
    IFunctionInfo, ITypeInfo

    public class IndexTypeInfo
    extends Object
    implements ITypeInfo, IFunctionInfo
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Method Detail

      • create

        public static IndexTypeInfo create​(IIndex index,
                                           IIndexBinding binding)
        Creates a type info suitable for the binding.
        Parameters:
        index - a non-null index in which to locate references
        binding -
        Since:
        4.0.1
      • create

        public static IndexTypeInfo create​(IIndex index,
                                           IIndexMacro macro)
        Creates a type info object suitable for a macro.
        Parameters:
        index - a non-null index in which to locate references
        macro - a macro to create a type info for
        Since:
        4.0.1
      • getCElementType

        public int getCElementType()
        Description copied from interface: ITypeInfo
        Returns the CElement type.
        Specified by:
        getCElementType in interface ITypeInfo
        Returns:
        ICElement.C_NAMESPACE, C_CLASS, C_STRUCT, C_UNION, C_ENUMERATION, or C_TYPEDEF, or zero if unknown type.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public boolean equals​(Object obj)
        Type info objects are equal if they compute the same references.
        Overrides:
        equals in class Object
      • isFileLocal

        public boolean isFileLocal()
        Since:
        5.1
      • getResolvedReference

        public ITypeReference getResolvedReference()
        Description copied from interface: ITypeInfo
        Returns the real location where type was declared.
        Specified by:
        getResolvedReference in interface ITypeInfo
        Returns:
        the parsed source reference (with offset and length), or null if not found.
      • getReferences

        public ITypeReference[] getReferences()
        Description copied from interface: ITypeInfo
        Returns the originating locations where this type was declared.
        Specified by:
        getReferences in interface ITypeInfo
        Returns:
        all known source references, or an empty array if none found.
      • encloses

        @Deprecated
        public boolean encloses​(ITypeInfo info)
        Deprecated.
        Specified by:
        encloses in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • exists

        @Deprecated
        public boolean exists()
        Deprecated.
        Specified by:
        exists in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • getEnclosingNamespace

        @Deprecated
        public ITypeInfo getEnclosingNamespace​(boolean includeGlobalNamespace)
        Deprecated.
        Specified by:
        getEnclosingNamespace in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • getRootNamespace

        @Deprecated
        public ITypeInfo getRootNamespace​(boolean includeGlobalNamespace)
        Deprecated.
        Specified by:
        getRootNamespace in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • hasEnclosedTypes

        @Deprecated
        public boolean hasEnclosedTypes()
        Deprecated.
        Specified by:
        hasEnclosedTypes in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • hasSubTypes

        @Deprecated
        public boolean hasSubTypes()
        Deprecated.
        Specified by:
        hasSubTypes in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • hasSuperTypes

        @Deprecated
        public boolean hasSuperTypes()
        Deprecated.
        Specified by:
        hasSuperTypes in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • isClass

        @Deprecated
        public boolean isClass()
        Deprecated.
        Specified by:
        isClass in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • isEnclosed

        @Deprecated
        public boolean isEnclosed​(ITypeInfo info)
        Deprecated.
        Specified by:
        isEnclosed in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • isEnclosedType

        @Deprecated
        public boolean isEnclosedType()
        Deprecated.
        Specified by:
        isEnclosedType in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • isEnclosingType

        @Deprecated
        public boolean isEnclosingType()
        Deprecated.
        Specified by:
        isEnclosingType in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • isUndefinedType

        @Deprecated
        public boolean isUndefinedType()
        Deprecated.
        Specified by:
        isUndefinedType in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.
      • setCElementType

        @Deprecated
        public void setCElementType​(int type)
        Deprecated.
        Specified by:
        setCElementType in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.