Package org.eclipse.cdt.core.browser

Class IndexTypeInfo

  • All Implemented Interfaces:
    IFunctionInfo, ITypeInfo
    public class IndexTypeInfo
extends java.lang.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.

      • getName

        public java.lang.String getName()
        Description copied from interface: ITypeInfo
        Returns the type name.
        Specified by:
        getName in interface ITypeInfo

      • getParameters

        public java.lang.String[] getParameters()
        Specified by:
        getParameters in interface IFunctionInfo
        Returns:
        the function parameter types

      • getReturnType

        public java.lang.String getReturnType()
        Specified by:
        getReturnType in interface IFunctionInfo
        Returns:
        the function return type

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Type info objects are equal if they compute the same references.
        Overrides:
        equals in class java.lang.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.

      • addDerivedReference

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

      • addReference

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

      • canSubstituteFor

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

      • 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.

      • getDerivedReferences

        @Deprecated
public ITypeReference[] getDerivedReferences()
        Deprecated.
        Specified by:
        getDerivedReferences in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.

      • getEnclosedTypes

        @Deprecated
public ITypeInfo[] getEnclosedTypes()
        Deprecated.
        Specified by:
        getEnclosedTypes in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.

      • getEnclosedTypes

        @Deprecated
public ITypeInfo[] getEnclosedTypes​(int[] kinds)
        Deprecated.
        Specified by:
        getEnclosedTypes 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.

      • getEnclosingType

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

      • getEnclosingType

        @Deprecated
public ITypeInfo getEnclosingType​(int[] kinds)
        Deprecated.
        Specified by:
        getEnclosingType 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.

      • getSubTypes

        @Deprecated
public ITypeInfo[] getSubTypes()
        Deprecated.
        Specified by:
        getSubTypes in interface ITypeInfo
        Restriction:
        This method is not intended to be referenced by clients.

      • getSuperTypes

        @Deprecated
public ITypeInfo[] getSuperTypes()
        Deprecated.
        Specified by:
        getSuperTypes 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.

      • isEnclosed

        @Deprecated
public boolean isEnclosed​(ITypeSearchScope scope)
        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.

      • isReferenced

        @Deprecated
public boolean isReferenced​(ITypeSearchScope scope)
        Deprecated.
        Specified by:
        isReferenced 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.