Dart API Referencedart:mirrorsDeclarationMirror

DeclarationMirror abstract class

A DeclarationMirror reflects some entity declared in a Dart program.

abstract class DeclarationMirror implements Mirror {
  /**
   * The simple name for this Dart language entity.
   *
   * The simple name is in most cases the the identifier name of the
   * entity, such as 'method' for a method [:void method() {...}:] or
   * 'mylibrary' for a [:#library('mylibrary');:] declaration.
   */
  String get simpleName;

  /**
   * The fully-qualified name for this Dart language entity.
   *
   * This name is qualified by the name of the owner. For instance,
   * the qualified name of a method 'method' in class 'Class' in
   * library 'library' is 'library.Class.method'.
   *
   * TODO(turnidge): Specify whether this name is unique.  Currently
   * this is a gray area due to lack of clarity over whether library
   * names are unique.
   */
  String get qualifiedName;

  /**
   * A mirror on the owner of this function.  This is the declaration
   * immediately surrounding the reflectee.
   *
   * Note that for libraries, the owner will be [:null:].
   */
  DeclarationMirror get owner;

  /**
   * Is this declaration private?
   *
   * Note that for libraries, this will be [:false:].
   */
  bool get isPrivate;

  /**
   * Is this declaration top-level?
   *
   * This is defined to be equivalent to:
   *    [:mirror.owner !== null && mirror.owner is LibraryMirror:]
   */
  bool get isTopLevel;

  /**
   * The source location of this Dart language entity.
   */
  SourceLocation get location;
}

Subclasses

LibraryMirror, MethodMirror, TypeMirror, VariableMirror

Implements

Mirror

Properties

final bool isPrivate #

Is this declaration private?

Note that for libraries, this will be false.

bool get isPrivate;

final bool isTopLevel #

Is this declaration top-level?

This is defined to be equivalent to: mirror.owner !== null && mirror.owner is LibraryMirror

bool get isTopLevel;

final SourceLocation location #

The source location of this Dart language entity.

SourceLocation get location;

final MirrorSystem mirrors #

inherited from Mirror

The MirrorSystem that contains this mirror.

MirrorSystem get mirrors;

final DeclarationMirror owner #

A mirror on the owner of this function. This is the declaration immediately surrounding the reflectee.

Note that for libraries, the owner will be null.

DeclarationMirror get owner;

final String qualifiedName #

The fully-qualified name for this Dart language entity.

This name is qualified by the name of the owner. For instance, the qualified name of a method 'method' in class 'Class' in library 'library' is 'library.Class.method'.

TODO(turnidge): Specify whether this name is unique. Currently this is a gray area due to lack of clarity over whether library names are unique.

String get qualifiedName;

final String simpleName #

The simple name for this Dart language entity.

The simple name is in most cases the the identifier name of the entity, such as 'method' for a method void method() {...} or 'mylibrary' for a #library('mylibrary'); declaration.

String get simpleName;