Класс SCRuntimeProperty

Класс представления свойства класса Подробнее...

#import <SCRuntimeProperty.h>

Граф наследования:SCRuntimeProperty:

Создание и инициализация свойств
(instancetype)	+ propertyWithObjCProperty:
(instancetype)	+ propertyWithName:attributes:
(instancetype)	+ propertyWithClass:name:
(instancetype)	+ classPropertyWithClass:name:
(instancetype)	- initWithObjCProperty:
(instancetype)	- initWithName:attributes:
(instancetype)	- initWithClass:instance:name:

Доступ к свойствам
NSString *	name
NSDictionary *	attributes
NSString *	attributeEncodings
BOOL	readonly
SCRuntimePropertySetterSemantics	setterSemantics
BOOL	assignProperty
BOOL	retainProperty
BOOL	copyProperty
BOOL	nonatomic
BOOL	dynamic
BOOL	weakReference
BOOL	eligibleForGarbageCollection
SEL	getter
SEL	setter
NSString *	getterName
NSString *	setterName
NSString *	encoding
NSString *	oldEncoding
NSString *	fieldName

Сравнение свойств
(BOOL)	- isEqualToProperty:
(BOOL)	- isEqualToName:
(BOOL)	- isEqual:
(BOOL)	- isEqualToObjCProperty:

Взаимодействие с классами
(BOOL)	- addToClass:instance:
(BOOL)	- addToUnregisteredClass:instance:
(BOOL)	- availableInClass:instance:
(BOOL)	- availableInUnregisteredClass:instance:

Взаимодействие с протоколами
(void)	- addToProtocol:required:instance:
(BOOL)	- availableInProtocol:required:instance:
(BOOL)	- availableInProtocolWithName:required:instance:

Дополнительные унаследованные члены
Методы экземпляра унаследованные от SCObject
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data
Свойства унаследованные от SCObject
NSString *	className

Подробное описание

Класс представления свойства класса

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Начиная с

версии 1.2.6

Обеспечивает доступ к свойствам классов среды времени выполнения:

• получение информации о существующих свойствах классов;
• создание новых свойств;
• доступ к различным параметрам свойств;
• добавление свойств к существующим классам и протоколам;
• поддержка классовых свойств (только для macOS и iOS).

При работе с экземплярами данного класса возможно возникновение следующих ошибок:

• SCL-20081: ошибка класса времени выполнения
• SCL-20085: ошибка свойства времени выполнения
• SCL-20086: ошибка протокола времени выполнения

Внимание

Некоторые методы данного класса не поддерживаются на платформе GNUstep. Перед использованием данного класса на этой платформе необходимо внимательно изучить документацию на класс и его методы.

Документация метода

- (BOOL) addToClass:		(Class)	class
instance:		(BOOL)	instance

SDK

macOS 10.6+, iOS 7.0+

Метод добавляет данное свойство к указанному существующему классу.

Аргументы

class	- класс для добавления свойства
instance	- YES для добавления свойства экземпляра класса и NO для добавления классового свойства

Возвращает

YES при успешном добавлении свойства и NO в противном случае

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

- (void) addToProtocol:		(SCRuntimeUnregisteredProtocol *)	protocol
required:		(BOOL)	required
instance:		(BOOL)	instance

SDK

macOS 10.6+, iOS 7.0+

Метод добавляет данное свойство к указанному незарегистрированному протоколу.

Аргументы

protocol	- протокол для добавления свойства
required	- YES для добавления обязательного свойства и NO для добавления опционального свойства
instance	- YES для добавления свойства экземпляра класса и NO для добавления классового свойства

Возвращает

YES при успешном добавлении свойства и NO в противном случае

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

- (BOOL) addToUnregisteredClass:		(SCRuntimeUnregisteredClass *)	class
instance:		(BOOL)	instance

Метод добавляет данное свойство к указанному незарегистрированному классу.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

class	- незарегистрированный класс для добавления свойства
instance	- YES для добавления свойства экземпляра класса и NO для добавления классового свойства (игнорируется на платформе GNUstep)

Возвращает

YES при успешном добавлении свойства и NO в противном случае

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

- (BOOL) availableInClass:		(Class)	class
instance:		(BOOL)	instance

Метод определяет наличие данного свойства в указанном классе.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

class	- существующий класс
instance	- YES для поиска свойства экземпляра класса и NO для поиска классового свойства (игнорируется на платформе GNUstep)

Возвращает

YES при наличии свойства в заданном классе и NO в противном случае

- (BOOL) availableInProtocol:		(SCRuntimeProtocol *)	protocol
required:		(BOOL)	required
instance:		(BOOL)	instance

Метод определяет наличие данного свойства в указанном протоколе.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

protocol	- существующий протокол
required	- YES для поиска обязательного свойства и NO для поиска опционального свойства
instance	- YES для поиска свойства экземпляра класса и NO для поиска классового свойства (игнорируется на платформе GNUstep)

Возвращает

YES при наличии свойства в заданном протоколе и NO в противном случае

- (BOOL) availableInProtocolWithName:		(NSString *)	name
required:		(BOOL)	required
instance:		(BOOL)	instance

Метод определяет наличие данного свойства в протоколе с заданным названием.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

name	- название протокола
required	- YES для поиска обязательного свойства и NO для поиска опционального свойства
instance	- YES для поиска свойства экземпляра класса и NO для поиска классового свойства (игнорируется на платформе GNUstep)

Возвращает

YES при наличии свойства в протоколе с указанным названием и NO в противном случае

- (BOOL) availableInUnregisteredClass:		(SCRuntimeUnregisteredClass *)	class
instance:		(BOOL)	instance

Метод определяет наличие данного свойства в указанном незарегистрированном классе.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

class	- незарегистрированный класс
instance	- YES для поиска свойства экземпляра класса и NO для поиска классового свойства (игнорируется на платформе GNUstep)

Возвращает

YES при наличии свойства в заданном незарегистрированном классе и NO в противном случае

+ (instancetype) classPropertyWithClass:		(Class)	class
name:		(NSString *)	name

SDK

macOS 10.6+, iOS 7.0+

Классовый метод создает классовое свойство с использованием заданных класса и названия свойства.

Аргументы

class	- класс
name	- название свойства

Возвращает

Созданное свойство

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

- (instancetype) initWithClass:		(Class)	class
instance:		(BOOL)	instance
name:		(NSString *)	name

SDK

macOS 10.6+, iOS 7.0+

Классовый метод создает свойство с использованием заданных класса, флага и названия свойства.

Внимание

Классовые свойства поддерживаются только на платформах macOS и iOS. При вызове данного метода на платформе GNUstep значение параметра instance игнорируется и метод всегда работает только со свойствами экземпляров класса.

Аргументы

class	- класс
instance	- YES для свойства экземпляра класса и NO для классового свойства (игнорируется на платформе GNUstep)
name	- название свойства

Возвращает

Созданное свойство

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

- (instancetype) initWithName:		(NSString *)	name
attributes:		(NSDictionary *)	attributes

Метод инициализирует свойство с использованием указанных названия и атрибутов.

Аргументы

name	- название свойства
attributes	- словарь с атрибутами свойства

Возвращает

Инициализированное свойство

- (instancetype) initWithObjCProperty:

(objc_property_t)

property

Метод инициализирует свойство с использованием заданного указателя на свойство среды времени выполнения.

Аргументы

property

- указатель на свойство

Возвращает

Инициализированное свойство

- (BOOL) isEqual:

(id)

object

Метод выполняет сравнение свойства с указанным объектом.

Аргументы

object

- объект для сравнения

Возвращает

YES если свойство совпадает с объектом и NO в противном случае

Переопределяет метод предка SCObject.

- (BOOL) isEqualToName:

(NSString *)

name

Метод выполняет сравнение свойства со свойством с указанным названием.

Аргументы

name	- название свойства для сравнения

Возвращает

YES если свойства совпадают и NO в противном случае

- (BOOL) isEqualToObjCProperty:

(objc_property_t)

property

Метод выполняет сравнение свойство с указателем на свойство среды времени выполнения.

Аргументы

property

- указатель на свойство среды времени выполнения для сравнения

Возвращает

YES если свойство совпадает с указателем и NO в противном случае

- (BOOL) isEqualToProperty:

(SCRuntimeProperty *)

property

Метод выполняет сравнение свойства с указанным свойством.

Аргументы

property

- свойство для сравнения

Возвращает

YES если свойства совпадают и NO в противном случае

+ (instancetype) propertyWithClass:		(Class)	class
name:		(NSString *)	name

Классовый метод создает свойство экземпляра класса с использованием заданных класса и названия свойства.

Аргументы

class	- класс
name	- название свойства

Возвращает

Созданное свойство

Исключения

SCRuntimeException

- обнаружена ошибка среды времени выполнения

+ (instancetype) propertyWithName:		(NSString *)	name
attributes:		(NSDictionary *)	attributes

Классовый метод создает свойство с использованием указанных названия и атрибутов.

Аргументы

name	- название свойства
attributes	- словарь с атрибутами свойства

Возвращает

Созданное свойство

+ (instancetype) propertyWithObjCProperty:

(objc_property_t)

property

Классовый метод создает свойство с использованием заданного указателя на свойство среды времени выполнения.

Аргументы

property

- указатель на свойство

Возвращает

Созданное свойство

Полный список свойств

- (BOOL) assignProperty

readnonatomicassign

Определяет наличие атрибута присвоения значения

- (NSString*) attributeEncodings

readnonatomicretain

Строка с обозначениями типов атрибутов свойства

- (NSDictionary *) attributes

readnonatomicretain

Словарь с атрибутами свойства

- (BOOL) copyProperty

readnonatomicassign

Определяет наличие атрибута копирования значения

- (BOOL) dynamic

readnonatomicassign

Определяет наличие атрибута динамического свойства

- (BOOL) eligibleForGarbageCollection

readnonatomicassign

Определяет наличие атрибута поддержки механизма сборки мусора

- (NSString *) encoding

readnonatomicretain

Обозначение типа свойства

- (NSString *) fieldName

readnonatomicretain

Поле свойства

- (SEL) getter

readnonatomicassign

Селектор метода получения значения свойства

- (NSString *) getterName

readnonatomicretain

Название метода получения значения свойства

- (NSString*) name

readnonatomicretain

Название свойства

- (BOOL) nonatomic

readnonatomicassign

Определяет наличие атрибута неатомарности свойства

- (NSString *) oldEncoding

readnonatomicretain

Обозначение типа свойства (старый формат)

- (BOOL) readonly

readnonatomicassign

Определяет доступность свойства в режиме "только для чтения"

- (BOOL) retainProperty

readnonatomicassign

Определяет наличие атрибута управления значением с помощью счетчика ссылок

- (SEL) setter

readnonatomicassign

Селектор метода задания значения свойства

- (NSString *) setterName

readnonatomicretain

Название метода задания значения свойства

- (SCRuntimePropertySetterSemantics) setterSemantics

readnonatomicassign

Семантика свойства

- (BOOL) weakReference

readnonatomicassign

Определяет наличие атрибута передачи значения по ссылке

---

Объявления и описания членов классов находятся в файлах:

• SCRuntimeProperty.h
• SCRuntimeProperty.m