Symbol (Akasha Java Browser API for GWT)

java.lang.Object
- akasha.core.Symbol

```
@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Symbol")
public class Symbol
extends java.lang.Object
```
The data type symbol is a primitive data type. The Symbol() function returns a value of type symbol, has static properties that expose several members of built-in objects, has static methods that expose the global symbol registry, and resembles a built-in object class, but is incomplete as a constructor because it does not support the syntax "new Symbol()".

See Also:

Symbol - MDN, Symbol - ECMAScript (ECMA-262)

Constructor Summary

Constructors
Modifier Constructor and Description

protected Symbol()

Constructors
Modifier	Constructor and Description
`protected`	`Symbol()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Symbol`	`_isConcatSpreadable()` The Symbol.isConcatSpreadable well-known symbol is used to configure if an object should be flattened to its array elements when using the Array.prototype.concat() method.
`static Symbol`	`asyncIterator()` The Symbol.asyncIterator well-known symbol specifies the default AsyncIterator for an object.
`static Symbol`	`for_(java.lang.String key)`
`static Symbol`	`hasInstance()` The Symbol.hasInstance well-known symbol is used to determine if a constructor object recognizes an object as its instance.
`static Symbol`	`iterator()` The well-known Symbol.iterator symbol specifies the default iterator for an object.
`static java.lang.String`	`keyFor(Symbol symbol)` The Symbol.keyFor(sym) method retrieves a shared symbol key from the global symbol registry for the given symbol.
`static Symbol`	`match()` The Symbol.match well-known symbol specifies the matching of a regular expression against a string.
`static Symbol`	`matchAll()` The Symbol.matchAll well-known symbol returns an iterator, that yields matches of the regular expression against a string.
`static Symbol`	`replace()` The Symbol.replace well-known symbol specifies the method that replaces matched substrings of a string.
`static Symbol`	`search()` The Symbol.search well-known symbol specifies the method that returns the index within a string that matches the regular expression.
`static Symbol`	`species()` The well-known symbol Symbol.species specifies a function-valued property that the constructor function uses to create derived objects.
`static Symbol`	`split()` The Symbol.split well-known symbol specifies the method that splits a string at the indices that match a regular expression.
`static Symbol`	`toPrimitive()` The Symbol.toPrimitive is a symbol that specifies a function valued property that is called to convert an object to a corresponding primitive value.
`java.lang.String`	`toString_()` The toString() method returns a string representing the specified Symbol object.
`static Symbol`	`toStringTag()` The Symbol.toStringTag well-known symbol is a string valued property that is used in the creation of the default string description of an object.
`static Symbol`	`unscopables()` The Symbol.unscopables well-known symbol is used to specify an object value of whose own and inherited property names are excluded from the with environment bindings of the associated object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Symbol
```
protected Symbol()
```
- Method Detail
  - asyncIterator
```
@JsProperty(name="asyncIterator")
 @Nonnull
public static Symbol asyncIterator()
```
    The Symbol.asyncIterator well-known symbol specifies the default AsyncIterator for an object. If this property is set on an object, it is an async iterable and can be used in a for await...of loop.
    
    See Also:
    
    Symbol.asyncIterator - MDN, Symbol.asyncIterator - ECMAScript (ECMA-262)
  - hasInstance
```
@JsProperty(name="hasInstance")
 @Nonnull
public static Symbol hasInstance()
```
    The Symbol.hasInstance well-known symbol is used to determine if a constructor object recognizes an object as its instance. The instanceof operator's behavior can be customized by this symbol.
    
    See Also:
    
    Symbol.hasInstance - MDN, Symbol.hasInstance - ECMAScript (ECMA-262)
  - _isConcatSpreadable
```
@JsProperty(name="isConcatSpreadable")
 @Nonnull
public static Symbol _isConcatSpreadable()
```
    The Symbol.isConcatSpreadable well-known symbol is used to configure if an object should be flattened to its array elements when using the Array.prototype.concat() method.
    
    See Also:
    
    Symbol.isConcatSpreadable - MDN, Symbol.isconcatspreadable - ECMAScript (ECMA-262)
  - iterator
```
@JsProperty(name="iterator")
 @Nonnull
public static Symbol iterator()
```
    The well-known Symbol.iterator symbol specifies the default iterator for an object. Used by for...of.
    
    See Also:
    
    Symbol.iterator - MDN, Symbol.iterator - ECMAScript (ECMA-262)
  - match
```
@JsProperty(name="match")
 @Nonnull
public static Symbol match()
```
    The Symbol.match well-known symbol specifies the matching of a regular expression against a string. This function is called by the String.prototype.match() method.
    
    See Also:
    
    Symbol.match - MDN, Symbol.match - ECMAScript (ECMA-262)
  - matchAll
```
@JsProperty(name="matchAll")
 @Nonnull
public static Symbol matchAll()
```
    The Symbol.matchAll well-known symbol returns an iterator, that yields matches of the regular expression against a string. This function is called by the String.prototype.matchAll() method.
    
    See Also:
    
    Symbol.matchAll - MDN, Symbol.matchAll - ECMAScript (ECMA-262)
  - replace
```
@JsProperty(name="replace")
 @Nonnull
public static Symbol replace()
```
    The Symbol.replace well-known symbol specifies the method that replaces matched substrings of a string. This function is called by the String.prototype.replace() method.
    
    See Also:
    
    Symbol.replace - MDN, Symbol.replace - ECMAScript (ECMA-262)
  - search
```
@JsProperty(name="search")
 @Nonnull
public static Symbol search()
```
    The Symbol.search well-known symbol specifies the method that returns the index within a string that matches the regular expression. This function is called by the String.prototype.search() method.
    
    See Also:
    
    Symbol.search - MDN, Symbol.search - ECMAScript (ECMA-262)
  - species
```
@JsProperty(name="species")
 @Nonnull
public static Symbol species()
```
    The well-known symbol Symbol.species specifies a function-valued property that the constructor function uses to create derived objects.
    
    See Also:
    
    Symbol.species - MDN, Symbol.species - ECMAScript (ECMA-262)
  - split
```
@JsProperty(name="split")
 @Nonnull
public static Symbol split()
```
    The Symbol.split well-known symbol specifies the method that splits a string at the indices that match a regular expression. This function is called by the String.prototype.split() method.
    
    See Also:
    
    Symbol.split - MDN, Symbol.split - ECMAScript (ECMA-262)
  - toPrimitive
```
@JsProperty(name="toPrimitive")
 @Nonnull
public static Symbol toPrimitive()
```
    The Symbol.toPrimitive is a symbol that specifies a function valued property that is called to convert an object to a corresponding primitive value.
    
    See Also:
    
    Symbol.toPrimitive - MDN, Symbol.toPrimitive - ECMAScript (ECMA-262)
  - toStringTag
```
@JsProperty(name="toStringTag")
 @Nonnull
public static Symbol toStringTag()
```
    The Symbol.toStringTag well-known symbol is a string valued property that is used in the creation of the default string description of an object. It is accessed internally by the Object.prototype.toString() method.
    
    See Also:
    
    Symbol.toStringTag - MDN, Symbol.toStringTag - ECMAScript (ECMA-262)
  - unscopables
```
@JsProperty(name="unscopables")
 @Nonnull
public static Symbol unscopables()
```
    The Symbol.unscopables well-known symbol is used to specify an object value of whose own and inherited property names are excluded from the with environment bindings of the associated object.
    
    See Also:
    
    Symbol.unscopables - MDN, Symbol.unscopables - ECMAScript (ECMA-262)
  - for_
```
@JsMethod(name="for")
 @Nonnull
public static Symbol for_(@Nonnull
                                                          java.lang.String key)
```
  - keyFor
```
@Nonnull
public static java.lang.String keyFor(@Nonnull
                                               Symbol symbol)
```
    The Symbol.keyFor(sym) method retrieves a shared symbol key from the global symbol registry for the given symbol.
    
    See Also:
    
    Symbol.keyFor - MDN, Symbol.keyFor - ECMAScript (ECMA-262)
  - toString_
```
@JsMethod(name="toString")
 @Nonnull
public java.lang.String toString_()
```
    The toString() method returns a string representing the specified Symbol object.
    
    See Also:
    
    Symbol.toString - MDN, Symbol.prototype.toString - ECMAScript (ECMA-262)

Class Symbol

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Symbol

Method Detail

asyncIterator

hasInstance

_isConcatSpreadable

iterator

match

matchAll

replace

search

species

split

toPrimitive

toStringTag

unscopables

for_

keyFor

toString_