class sap.ui.base.Metadata

Control sample: sap.ui.base.Metadata
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Extends:
Module: sap/ui/base/Metadata
Application Component: CA-UI5-COR

Metadata for a class.


Constructor

Creates a new metadata object from the given static infos.

Note: Throughout this class documentation, the described subclass of Object is referenced as the described class.

new sap.ui.base.Metadata(sClassName, oClassInfo)
Param Type Default Value Description
sClassName string

Fully qualified name of the described class

oClassInfo object

Info to construct the class and its metadata from


Methods Overview

Method Description
getAllPublicMethods

Returns an array with the names of all public methods declared by the described class and all its ancestors classes.

Since 1.58 this method should not be used for productive code. The accuracy of the returned information highly depends on the concrete class and is not actively monitored. There might be more public methods or some of the returned methods might not really be intended for public use. In general, pure visibility information should not be exposed in runtime metadata but be part of the documentation. Subclasses of <code>sap.ui.base.Object</code> might decide to provide runtime metadata describing their public API, but this then should not be backed by this method. See {@link sap.ui.core.mvc.ControllerMetadata#getAllMethods} for an example.
getClass

Returns the (constructor of the) described class

getName

Returns the fully qualified name of the described class

getParent

Returns the metadata object of the base class of the described class or null if the class has no (documented) base class.

getPublicMethods

Returns an array with the names of the public methods declared by the described class, methods of ancestors are not listed.

Since 1.58 this method should not be used for productive code. The accuracy of the returned information highly depends on the concrete class and is not actively monitored. There might be more public methods or some of the returned methods might not really be intended for public use. In general, pure visibility information should not be exposed in runtime metadata but be part of the documentation. Subclasses of <code>sap.ui.base.Object</code> might decide to provide runtime metadata describing their public API, but this then should not be backed by this method. See {@link sap.ui.core.mvc.ControllerMetadata#getAllMethods} for an example.
getStereotype

Stereotype of the described class.

isA

Checks whether the class described by this metadata object is of the named type.

This check is solely based on the type names as declared in the class metadata. It compares the given vTypeName with the name of this class, with the names of any base class of this class and with the names of all interfaces implemented by any of the aforementioned classes.

Instead of a single type name, an array of type names can be given and the method will check if this class is of any of the listed types (logical or).

Should the UI5 class system in future implement additional means of associating classes with type names (e.g. by introducing mixins), then this method might detect matches for those names as well.

isAbstract

Returns whether the described class is abstract

isDeprecated

Whether the described class is deprecated and should not be used any more

isFinal

Returns whether the described class is final

isInstanceOf

Checks whether the described class or one of its ancestor classes implements the given interface.

getAllPublicMethods

Returns an array with the names of all public methods declared by the described class and all its ancestors classes.

Since 1.58 this method should not be used for productive code. The accuracy of the returned information highly depends on the concrete class and is not actively monitored. There might be more public methods or some of the returned methods might not really be intended for public use. In general, pure visibility information should not be exposed in runtime metadata but be part of the documentation. Subclasses of <code>sap.ui.base.Object</code> might decide to provide runtime metadata describing their public API, but this then should not be backed by this method. See {@link sap.ui.core.mvc.ControllerMetadata#getAllMethods} for an example.

getClass

Returns the (constructor of the) described class

getName

Returns the fully qualified name of the described class

getParent

Returns the metadata object of the base class of the described class or null if the class has no (documented) base class.

getPublicMethods

Returns an array with the names of the public methods declared by the described class, methods of ancestors are not listed.

Since 1.58 this method should not be used for productive code. The accuracy of the returned information highly depends on the concrete class and is not actively monitored. There might be more public methods or some of the returned methods might not really be intended for public use. In general, pure visibility information should not be exposed in runtime metadata but be part of the documentation. Subclasses of <code>sap.ui.base.Object</code> might decide to provide runtime metadata describing their public API, but this then should not be backed by this method. See {@link sap.ui.core.mvc.ControllerMetadata#getAllMethods} for an example.

getStereotype

Stereotype of the described class.

isA

Checks whether the class described by this metadata object is of the named type.

This check is solely based on the type names as declared in the class metadata. It compares the given vTypeName with the name of this class, with the names of any base class of this class and with the names of all interfaces implemented by any of the aforementioned classes.

Instead of a single type name, an array of type names can be given and the method will check if this class is of any of the listed types (logical or).

Should the UI5 class system in future implement additional means of associating classes with type names (e.g. by introducing mixins), then this method might detect matches for those names as well.

Param Type DefaultValue Description
vTypeName string string[]

Type or types to check for

isAbstract

Returns whether the described class is abstract

isDeprecated

Whether the described class is deprecated and should not be used any more

isFinal

Returns whether the described class is final

isInstanceOf

Checks whether the described class or one of its ancestor classes implements the given interface.

Param Type DefaultValue Description
sInterface string

name of the interface to test for (in dot notation)