JUCE: Identifier Class Reference

JUCE

Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Identifier Class Referencefinal
juce_core » text

Represents a string identifier, designed for accessing properties by name. More...

`#include <juce_Identifier.h>`

## Public Member Functions
| Identifier () noexcept
| Creates a null identifier. More...
| Identifier (const char *name)
| Creates an identifier with a specified name. More...
| Identifier (const String &name)
| Creates an identifier with a specified name. More...
| Identifier (String::CharPointerType nameStart, String::CharPointerType nameEnd)
| Creates an identifier with a specified name. More...
| Identifier (const Identifier &other) noexcept
| Creates a copy of another identifier. More...
Identifier & | operator= (const Identifier &other) noexcept
| Creates a copy of another identifier. More...
| Identifier (Identifier &&other) noexcept
| Creates a copy of another identifier. More...
Identifier & | operator= (Identifier &&other) noexcept
| Creates a copy of another identifier. More...
| ~Identifier () noexcept
| Destructor. More...
bool | operator== (const Identifier &other) const noexcept
| Compares two identifiers. More...
bool | operator!= (const Identifier &other) const noexcept
| Compares two identifiers. More...
bool | operator== (StringRef other) const noexcept
| Compares the identifier with a string. More...
bool | operator!= (StringRef other) const noexcept
| Compares the identifier with a string. More...
bool | operator< (StringRef other) const noexcept
| Compares the identifier with a string. More...
bool | operator<= (StringRef other) const noexcept
| Compares the identifier with a string. More...
bool | operator> (StringRef other) const noexcept
| Compares the identifier with a string. More...
bool | operator>= (StringRef other) const noexcept
| Compares the identifier with a string. More...
const String & | toString () const noexcept
| Returns this identifier as a string. More...
| operator String::CharPointerType () const noexcept
| Returns this identifier's raw string pointer. More...
String::CharPointerType | getCharPointer () const noexcept
| Returns this identifier's raw string pointer. More...
| operator StringRef () const noexcept
| Returns this identifier as a StringRef. More...
bool | isValid () const noexcept
| Returns true if this Identifier is not null. More...
bool | isNull () const noexcept
| Returns true if this Identifier is null. More...

## Static Public Member Functions
static bool | isValidIdentifier (const String &possibleIdentifier) noexcept
| Checks a given string for characters that might not be valid in an Identifier. More...

## Static Public Attributes
static Identifier | null
| A null identifier. More...

## Detailed Description

Represents a string identifier, designed for accessing properties by name.

Comparing two Identifier objects is very fast (an O(1) operation), but creating them can be slower than just using a String directly, so the optimal way to use them is to keep some static Identifier objects for the things you use often.

See also
  NamedValueSet, ValueTree

## Constructor & Destructor Documentation

## ◆ Identifier() [1/6]

Identifier::Identifier | ( |  | ) |
| noexcept

Creates a null identifier.

## ◆ Identifier() [2/6]

Identifier::Identifier | ( | const char * | name | ) |

Creates an identifier with a specified name.

Because this name may need to be used in contexts such as script variables or XML tags, it must only contain ascii letters and digits, or the underscore character.

## ◆ Identifier() [3/6]

Identifier::Identifier | ( | const String & | name | ) |

Creates an identifier with a specified name.

Because this name may need to be used in contexts such as script variables or XML tags, it must only contain ascii letters and digits, or the underscore character.

## ◆ Identifier() [4/6]

Identifier::Identifier | ( | String::CharPointerType | nameStart,
|  | String::CharPointerType | nameEnd
| ) |  |

Creates an identifier with a specified name.

Because this name may need to be used in contexts such as script variables or XML tags, it must only contain ascii letters and digits, or the underscore character.

## ◆ Identifier() [5/6]

Identifier::Identifier | ( | const Identifier & | other | ) |
| noexcept

Creates a copy of another identifier.

## ◆ Identifier() [6/6]

Identifier::Identifier | ( | Identifier && | other | ) |
| noexcept

Creates a copy of another identifier.

## ◆ ~Identifier()

Identifier::~Identifier | ( |  | ) |
| noexcept

Destructor.

## Member Function Documentation

## ◆ operator=() [1/2]

Identifier & Identifier::operator= | ( | const Identifier & | other | ) |
| noexcept

Creates a copy of another identifier.

## ◆ operator=() [2/2]

Identifier & Identifier::operator= | ( | Identifier && | other | ) |
| noexcept

Creates a copy of another identifier.

## ◆ operator==() [1/2]

bool Identifier::operator== | ( | const Identifier & | other | ) | const
| noexcept

Compares two identifiers.

This is a very fast operation.

References gl::name.

## ◆ operator!=() [1/2]

bool Identifier::operator!= | ( | const Identifier & | other | ) | const
| noexcept

Compares two identifiers.

This is a very fast operation.

References gl::name.

## ◆ operator==() [2/2]

bool Identifier::operator== | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ operator!=() [2/2]

bool Identifier::operator!= | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ operator<()

bool Identifier::operator< | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ operator<=()

bool Identifier::operator<= | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ operator>()

bool Identifier::operator> | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ operator>=()

bool Identifier::operator>= | ( | StringRef | other | ) | const
| noexcept

Compares the identifier with a string.

References gl::name.

## ◆ toString()

const String & Identifier::toString | ( |  | ) | const
| noexcept

Returns this identifier as a string.

References gl::name.

## ◆ operator String::CharPointerType()

Identifier::operator String::CharPointerType | ( |  | ) | const
| noexcept

Returns this identifier's raw string pointer.

References gl::name.

## ◆ getCharPointer()

String::CharPointerType Identifier::getCharPointer | ( |  | ) | const
| noexcept

Returns this identifier's raw string pointer.

References gl::name.

## ◆ operator StringRef()

Identifier::operator StringRef | ( |  | ) | const
| noexcept

Returns this identifier as a StringRef.

References gl::name.

## ◆ isValid()

bool Identifier::isValid | ( |  | ) | const
| noexcept

Returns true if this Identifier is not null.

References gl::name.

## ◆ isNull()

bool Identifier::isNull | ( |  | ) | const
| noexcept

Returns true if this Identifier is null.

References gl::name.

## ◆ isValidIdentifier()

static bool Identifier::isValidIdentifier | ( | const String & | possibleIdentifier | ) |
| staticnoexcept

Checks a given string for characters that might not be valid in an Identifier.

Since Identifiers are used as a script variables and XML attributes, they should only contain alphanumeric characters, underscores, or the '-' and ':' characters.

## Member Data Documentation

## ◆ null

Identifier Identifier::null
| static

A null identifier.

The documentation for this class was generated from the following file:

- juce_Identifier.h