Package org.eclipse.cdt.core.browser
Class IndexTypeInfo
- java.lang.Object
-
- org.eclipse.cdt.core.browser.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.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.cdt.core.browser.ITypeInfo
KNOWN_TYPES
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDerivedReference(ITypeReference location)
Deprecated.void
addReference(ITypeReference location)
Deprecated.boolean
canSubstituteFor(ITypeInfo info)
Deprecated.static IndexTypeInfo
create(IndexTypeInfo rhs, ITypeReference ref)
static IndexTypeInfo
create(IIndex index, IIndexBinding binding)
Creates a type info suitable for the binding.static IndexTypeInfo
create(IIndex index, IIndexMacro macro)
Creates a type info object suitable for a macro.boolean
encloses(ITypeInfo info)
Deprecated.boolean
equals(Object obj)
Type info objects are equal if they compute the same references.boolean
exists()
Deprecated.int
getCElementType()
Returns the CElement type.ITypeReference[]
getDerivedReferences()
Deprecated.ITypeInfo[]
getEnclosedTypes()
Deprecated.ITypeInfo[]
getEnclosedTypes(int[] kinds)
Deprecated.ITypeInfo
getEnclosingNamespace(boolean includeGlobalNamespace)
Deprecated.ICProject
getEnclosingProject()
Returns the enclosing project.ITypeInfo
getEnclosingType()
Deprecated.ITypeInfo
getEnclosingType(int[] kinds)
Deprecated.String
getName()
Returns the type name.String[]
getParameters()
IQualifiedTypeName
getQualifiedTypeName()
Returns the qualified type name.ITypeReference[]
getReferences()
Returns the originating locations where this type was declared.ITypeReference
getResolvedReference()
Returns the real location where type was declared.String
getReturnType()
ITypeInfo
getRootNamespace(boolean includeGlobalNamespace)
Deprecated.ITypeInfo[]
getSubTypes()
Deprecated.ASTAccessVisibility
getSuperTypeAccess(ITypeInfo subType)
Deprecated.ITypeInfo[]
getSuperTypes()
Deprecated.boolean
hasEnclosedTypes()
Deprecated.int
hashCode()
boolean
hasSubTypes()
Deprecated.boolean
hasSuperTypes()
Deprecated.boolean
isClass()
Deprecated.boolean
isEnclosed(ITypeInfo info)
Deprecated.boolean
isEnclosed(ITypeSearchScope scope)
Deprecated.boolean
isEnclosedType()
Deprecated.boolean
isEnclosingType()
Deprecated.boolean
isFileLocal()
boolean
isReferenced(ITypeSearchScope scope)
Deprecated.boolean
isUndefinedType()
Deprecated.void
setCElementType(int type)
Deprecated.
-
-
-
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 referencesbinding
-- 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 referencesmacro
- a macro to create a type info for- Since:
- 4.0.1
-
create
public static IndexTypeInfo create(IndexTypeInfo rhs, ITypeReference ref)
- Since:
- 5.1
-
getCElementType
public int getCElementType()
Description copied from interface:ITypeInfo
Returns the CElement type.- Specified by:
getCElementType
in interfaceITypeInfo
- Returns:
- ICElement.C_NAMESPACE, C_CLASS, C_STRUCT, C_UNION, C_ENUMERATION, or C_TYPEDEF, or zero if unknown type.
-
getEnclosingProject
public ICProject getEnclosingProject()
Description copied from interface:ITypeInfo
Returns the enclosing project.- Specified by:
getEnclosingProject
in interfaceITypeInfo
-
getQualifiedTypeName
public IQualifiedTypeName getQualifiedTypeName()
Description copied from interface:ITypeInfo
Returns the qualified type name.- Specified by:
getQualifiedTypeName
in interfaceITypeInfo
-
getParameters
public String[] getParameters()
- Specified by:
getParameters
in interfaceIFunctionInfo
- Returns:
- the function parameter types
-
getReturnType
public String getReturnType()
- Specified by:
getReturnType
in interfaceIFunctionInfo
- Returns:
- the function return type
-
equals
public boolean equals(Object obj)
Type info objects are equal if they compute the same references.
-
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 interfaceITypeInfo
- 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 interfaceITypeInfo
- Returns:
- all known source references, or an empty array if none found.
-
addDerivedReference
@Deprecated public void addDerivedReference(ITypeReference location)
Deprecated.- Specified by:
addDerivedReference
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
addReference
@Deprecated public void addReference(ITypeReference location)
Deprecated.- Specified by:
addReference
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
canSubstituteFor
@Deprecated public boolean canSubstituteFor(ITypeInfo info)
Deprecated.- Specified by:
canSubstituteFor
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
encloses
@Deprecated public boolean encloses(ITypeInfo info)
Deprecated.
-
exists
@Deprecated public boolean exists()
Deprecated.
-
getDerivedReferences
@Deprecated public ITypeReference[] getDerivedReferences()
Deprecated.- Specified by:
getDerivedReferences
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getEnclosedTypes
@Deprecated public ITypeInfo[] getEnclosedTypes()
Deprecated.- Specified by:
getEnclosedTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getEnclosedTypes
@Deprecated public ITypeInfo[] getEnclosedTypes(int[] kinds)
Deprecated.- Specified by:
getEnclosedTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getEnclosingNamespace
@Deprecated public ITypeInfo getEnclosingNamespace(boolean includeGlobalNamespace)
Deprecated.- Specified by:
getEnclosingNamespace
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getEnclosingType
@Deprecated public ITypeInfo getEnclosingType()
Deprecated.- Specified by:
getEnclosingType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getEnclosingType
@Deprecated public ITypeInfo getEnclosingType(int[] kinds)
Deprecated.- Specified by:
getEnclosingType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getRootNamespace
@Deprecated public ITypeInfo getRootNamespace(boolean includeGlobalNamespace)
Deprecated.- Specified by:
getRootNamespace
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getSubTypes
@Deprecated public ITypeInfo[] getSubTypes()
Deprecated.- Specified by:
getSubTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getSuperTypeAccess
@Deprecated public ASTAccessVisibility getSuperTypeAccess(ITypeInfo subType)
Deprecated.- Specified by:
getSuperTypeAccess
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
getSuperTypes
@Deprecated public ITypeInfo[] getSuperTypes()
Deprecated.- Specified by:
getSuperTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
hasEnclosedTypes
@Deprecated public boolean hasEnclosedTypes()
Deprecated.- Specified by:
hasEnclosedTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
hasSubTypes
@Deprecated public boolean hasSubTypes()
Deprecated.- Specified by:
hasSubTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
hasSuperTypes
@Deprecated public boolean hasSuperTypes()
Deprecated.- Specified by:
hasSuperTypes
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isClass
@Deprecated public boolean isClass()
Deprecated.
-
isEnclosed
@Deprecated public boolean isEnclosed(ITypeInfo info)
Deprecated.- Specified by:
isEnclosed
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isEnclosed
@Deprecated public boolean isEnclosed(ITypeSearchScope scope)
Deprecated.- Specified by:
isEnclosed
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isEnclosedType
@Deprecated public boolean isEnclosedType()
Deprecated.- Specified by:
isEnclosedType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isEnclosingType
@Deprecated public boolean isEnclosingType()
Deprecated.- Specified by:
isEnclosingType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isReferenced
@Deprecated public boolean isReferenced(ITypeSearchScope scope)
Deprecated.- Specified by:
isReferenced
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
isUndefinedType
@Deprecated public boolean isUndefinedType()
Deprecated.- Specified by:
isUndefinedType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
setCElementType
@Deprecated public void setCElementType(int type)
Deprecated.- Specified by:
setCElementType
in interfaceITypeInfo
- Restriction:
- This method is not intended to be referenced by clients.
-
-