CodeQL library for Java/Kotlin
codeql/java-all 4.2.1-dev (changelog, source)
Search

Class CollectionType

A reference type that extends a parameterization of java.util.Collection.

Import path

import semmle.code.java.Collections

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getElementType

    Gets the type of elements stored in this collection.

    Inherited predicates

    commonSubtype

    A common (reflexive, transitive) subtype of the erasures of types t1 and t2, if it exists.

    from RefType
    compilerGeneratedReason

    Gets the reason this element was generated by the compiler, if any.

    from Element
    contains

    Holds if this element transitively contains the specified element e.

    from Element
    declaresField

    Holds if this type declares a field with the specified name.

    from RefType
    declaresMethod

    Holds if this type declares a method with the specified name.

    from RefType
    declaresMethod

    Holds if this type declares a method with the specified name and number of parameters.

    from RefType
    extendsOrImplements

    Holds if t is an immediate super-type of this type using only the immediate extends or implements relationships. In particular, this excludes parameter containment sub-typing for parameterized types.

    from RefType
    fromSource

    Holds if this element pertains to a source file.

    from Element
    getACallable

    Gets a method or constructor declared in this type.

    from RefType
    getAConstructor

    Gets a constructor declared in this type.

    from RefType
    getADeclaredAnnotation

    Gets an annotation that is declared on this element, excluding inherited annotations. The retention policy of the annotation type is not considered.

    from Annotatable
    getADescendant

    Gets a direct or indirect descendant of this type, including itself.

    from RefType
    getAField

    Gets a field declared in this type.

    from RefType
    getAMember

    Gets a member declared in this type.

    from RefType
    getAMethod

    Gets a method declared in this type.

    from RefType
    getAModifier

    Gets a modifier of this element.

    from Modifiable
    getAPrimaryQlClass

    Gets the name of a primary CodeQL class to which this element belongs.

    from Top
    getASourceSupertype

    Gets the source declaration of a direct supertype of this type, excluding itself.

    from RefType
    getAStrictAncestor

    Gets a direct or indirect supertype of this type. This does not include itself, unless this type is part of a cycle in the type hierarchy.

    from RefType
    getASubtype

    Gets a direct subtype of this type.

    from RefType
    getASupertype

    Gets a direct supertype of this type.

    from RefType
    getAnAncestor

    Gets a direct or indirect supertype of this type, including itself.

    from RefType
    getAnAnnotation

    Gets an annotation that applies to this element, including inherited annotations. The results only include direct annotations; indirect annotations, that is repeated annotations in an (implicit) container annotation, are not included. The retention policy of the annotation type is not considered.

    from Annotatable
    getAnAssociatedAnnotation

    Gets an annotation associated with this element, that is: - An annotation directly present on this element, or - An annotation indirectly present on this element (in the form of a repeated annotation), or - If an annotation of a type is neither directly nor indirectly present the result is an associated inherited annotation (recursively)

    from Annotatable
    getCompilationUnit

    Gets the compilation unit in which this type is declared.

    from RefType
    getDoc

    Cast this element to a Documentable.

    from Element
    getEnclosingType

    Gets the type in which this reference type is enclosed, if any.

    from RefType
    getErasure

    Gets the erasure of this type.

    from Type
    getFile

    Gets the file associated with this element.

    from Top
    getLocation

    Gets the source location for this element.

    from Top
    getMetrics

    Cast this reference type to a class that provides access to metrics information.

    from RefType
    getName

    Gets the name of this element.

    from Element
    getNestedName

    Gets the nested name of this type.

    from RefType
    getNumberOfCommentLines

    Gets the number of comment lines that this element ranges over.

    from Top
    getNumberOfLinesOfCode

    Gets the number of lines of code that this element ranges over.

    from Top
    getNumberOfMethods

    Gets the number of methods declared in this type.

    from RefType
    getPackage

    Gets the package in which this type is declared.

    from RefType
    getPrimaryQlClasses

    Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

    from Top
    getQualifiedName

    Gets the qualified name of this type, consisting of the package name followed by a . and the name of this type.

    from RefType
    getSourceDeclaration

    Gets the source declaration of this type.

    from RefType
    getTotalNumberOfLines

    Gets the total number of lines that this element ranges over, including lines of code, comment and whitespace-only lines.

    from Top
    getTypeDescriptor

    Gets the JVM descriptor for this type, as used in bytecode.

    from RefType
    hasAnnotation

    Holds if this element has an annotation, including inherited annotations. The retention policy of the annotation type is not considered.

    from Annotatable
    hasAnnotation

    Holds if this element has the specified annotation, including inherited annotations. The retention policy of the annotation type is not considered.

    from Annotatable
    hasChildElement

    Holds if this element is the immediate parent of the specified element e.

    from Element
    hasDeclaredAnnotation

    Holds if this element has a declared annotation, excluding inherited annotations. The retention policy of the annotation type is not considered.

    from Annotatable
    hasLocationInfo

    Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

    from Top
    hasMember

    Holds if this type declares any members.

    from RefType
    hasMethod

    Holds if this type declares or inherits method m, which is declared in declaringType.

    from RefType
    hasMethod

    Holds if this type declares or inherits method m, which is declared in declaringType. Methods that would be inherited if they were public, but are not inherited due to being package protected, are also included and indicated by hidden being true.

    from RefType
    hasModifier

    Holds if this element has modifier m.

    from Modifiable
    hasName

    Holds if this element has the specified name.

    from Element
    hasNoModifier

    Holds if this element has no modifier.

    from Modifiable
    hasQualifiedName

    Holds if this type is declared in a specified package with the specified name.

    from RefType
    hasSubtype

    Holds if t is an immediate subtype of this type.

    from RefType
    hasSupertype

    Holds if t is an immediate supertype of this type.

    from RefType
    inherits

    Holds if this type declares or inherits the specified member.

    from RefType
    isAbstract

    Holds if this element has an abstract modifier or is implicitly abstract.

    from Modifiable
    isCompilerGenerated

    Holds if this is an auxiliary program element generated by the compiler.

    from Element
    isCrossinline

    Holds if this element has a crossinline modifier.

    from Modifiable
    isDefault

    Holds if this element has a default modifier.

    from Modifiable
    isFinal

    Holds if this element has a final modifier or is implicitly final.

    from Modifiable
    isIn

    Holds if this element has an in modifier.

    from Modifiable
    isInline

    Holds if this element has an inline modifier.

    from Modifiable
    isInternal

    Holds if this element has an internal modifier.

    from Modifiable
    isLateinit

    Holds if this element has a lateinit modifier.

    from Modifiable
    isNative

    Holds if this element has a native modifier.

    from Modifiable
    isNoinline

    Holds if this element has a noinline modifier.

    from Modifiable
    isOut

    Holds if this element has an out modifier.

    from Modifiable
    isPrivate

    Holds if this element has a private modifier or is implicitly private.

    from Modifiable
    isProtected

    Holds if this element has a protected modifier.

    from Modifiable
    isPublic

    Holds if this element has a public modifier or is implicitly public.

    from Modifiable
    isReified

    Holds if this element has a reified modifier.

    from Modifiable
    isSealedKotlin

    Holds if this element has a sealed modifier.

    from Modifiable
    isSourceDeclaration

    Holds if this type is the same as its source declaration.

    from RefType
    isStatic

    Holds if this element has a static modifier or is implicitly static.

    from Modifiable
    isStrictfp

    Holds if this element has a strictfp modifier.

    from Modifiable
    isStub

    Holds if this element is from source and classified as a stub implementation. An implementation is considered a stub, if the the path to the source file contains /stubs/.

    from Element
    isSuspend

    Holds if this element has a suspend modifier.

    from Modifiable
    isSynchronized

    Holds if this element has a synchronized modifier.

    from Modifiable
    isTopLevel

    Holds if this is a top-level type, which is not nested inside any other types.

    from RefType
    isTransient

    Holds if this element has a transient modifier.

    from Modifiable
    isVolatile

    Holds if this element has a volatile modifier.

    from Modifiable
    nestedName

    DEPRECATED: Alias for getNestedName.

    from RefType
    suppressesWarningsAbout

    Holds if this or any enclosing Annotatable has a @SuppressWarnings("<category>") annotation attached to it for the specified category.

    from Annotatable
    toString

    Gets a textual representation of this element.

    from Top

    Charpred