qtil
advanced-security/qtil-ruby 0.0.2
Search

Class OptionalParameter

An optional parameter. For example, the parameter name in the following code:

def say_hello(name = 'Anon')
  puts "hello #{name}"
end

Import path

import codeql.ruby.ast.Parameter

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getAChild

    Gets a child of this node, which can also be retrieved using a predicate named pred.

    getAPrimaryQlClass

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

    getDefaultValue

    Gets the default value, i.e. the value assigned to the parameter when one is not provided by the caller.

    getLocation

    Gets the location of this node.

    getName

    Gets the name of this parameter.

    getVariable

    Gets the variable introduced by this parameter.

    toString

    Gets a textual representation of this node.

    Inherited predicates

    getAChild

    Gets a child node of this AstNode.

    from AstNode
    getAVariable

    Gets a variable introduced by this parameter.

    from NamedParameter
    getAnAccess

    Gets an access to this parameter.

    from NamedParameter
    getCallable

    Gets the callable that this parameter belongs to.

    from Parameter
    getDefiningAccess

    Gets the access that defines the underlying local variable.

    from NamedParameter
    getDesugared

    Gets the desugared version of this AST node, if any.

    from AstNode
    getEnclosingMethod

    Gets the enclosing method, if any.

    from AstNode
    getEnclosingModule

    Gets the enclosing module, if any.

    from AstNode
    getEnclosingToplevel

    Gets the enclosing top-level.

    from AstNode
    getFile

    Gets the file of this node.

    from AstNode
    getParent

    Gets the parent of this AstNode, if this node is not a root node.

    from AstNode
    getPosition

    Gets the zero-based position of this parameter.

    from Parameter
    getPrimaryQlClasses

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

    from AstNode
    getVariable

    Gets the variable named name introduced by this parameter.

    from Parameter
    hasName

    Holds if the name of this parameter is name.

    from NamedParameter
    isSynthesized

    Holds if this node was synthesized to represent an implicit AST node not present in the source code. In the following example method call, the receiver is an implicit self reference, for which there is a synthesized Self node.

    from AstNode

    Charpred