juce::Identifier Class Reference

#include <juce_Identifier.h>

Public Member Functions
	Identifier () noexcept
	Identifier (const char *name)
	Identifier (const String &name)
	Identifier (String::CharPointerType nameStart, String::CharPointerType nameEnd)
	Identifier (const Identifier &other) noexcept
Identifier &	operator= (const Identifier &other) noexcept
	Identifier (Identifier &&other) noexcept
Identifier &	operator= (Identifier &&other) noexcept
	~Identifier () noexcept
bool	operator== (const Identifier &other) const noexcept
bool	operator!= (const Identifier &other) const noexcept
bool	operator== (StringRef other) const noexcept
bool	operator!= (StringRef other) const noexcept
bool	operator< (StringRef other) const noexcept
bool	operator<= (StringRef other) const noexcept
bool	operator> (StringRef other) const noexcept
bool	operator>= (StringRef other) const noexcept
const String &	toString () const noexcept
	operator String::CharPointerType () const noexcept
String::CharPointerType	getCharPointer () const noexcept
	operator StringRef () const noexcept
bool	isValid () const noexcept
bool	isNull () const noexcept

Static Public Member Functions
static bool	isValidIdentifier (const String &possibleIdentifier) noexcept

Static Public Attributes
static Identifier	null

Private Attributes
String	name

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

@tags{Core}

Constructor & Destructor Documentation

Identifier() [1/6]

juce::Identifier::Identifier ( )

noexcept

Creates a null identifier.

Identifier() [2/6]

juce::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]

juce::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]

juce::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]

juce::Identifier::Identifier ( const Identifier & other )

noexcept

Creates a copy of another identifier.

Identifier() [6/6]

juce::Identifier::Identifier ( Identifier && other )

noexcept

Creates a copy of another identifier.

~Identifier()

juce::Identifier::~Identifier ( )

noexcept

Destructor

Member Function Documentation

getCharPointer()

String::CharPointerType juce::Identifier::getCharPointer ( ) const

inlinenoexcept

Returns this identifier's raw string pointer.

isNull()

bool juce::Identifier::isNull ( ) const

inlinenoexcept

Returns true if this Identifier is null

isValid()

bool juce::Identifier::isValid ( ) const

inlinenoexcept

Returns true if this Identifier is not null

isValidIdentifier()

bool juce::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.

operator String::CharPointerType()

juce::Identifier::operator String::CharPointerType ( ) const

inlinenoexcept

Returns this identifier's raw string pointer.

operator StringRef()

juce::Identifier::operator StringRef ( ) const

inlinenoexcept

Returns this identifier as a StringRef.

operator!=() [1/2]

bool juce::Identifier::operator!= ( const Identifier & other ) const

inlinenoexcept

Compares two identifiers. This is a very fast operation.

operator!=() [2/2]

bool juce::Identifier::operator!= ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

operator<()

bool juce::Identifier::operator< ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

operator<=()

bool juce::Identifier::operator<= ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

operator=() [1/2]

Identifier & juce::Identifier::operator= ( const Identifier & other )

noexcept

Creates a copy of another identifier.

operator=() [2/2]

Identifier & juce::Identifier::operator= ( Identifier && other )

noexcept

Creates a copy of another identifier.

operator==() [1/2]

bool juce::Identifier::operator== ( const Identifier & other ) const

inlinenoexcept

Compares two identifiers. This is a very fast operation.

operator==() [2/2]

bool juce::Identifier::operator== ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

operator>()

bool juce::Identifier::operator> ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

operator>=()

bool juce::Identifier::operator>= ( StringRef other ) const

inlinenoexcept

Compares the identifier with a string.

toString()

const String & juce::Identifier::toString ( ) const

inlinenoexcept

Returns this identifier as a string.

Member Data Documentation

name

String juce::Identifier::name

private

null

Identifier juce::Identifier::null

static

A null identifier.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/text/juce_Identifier.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/text/juce_Identifier.cpp