SCDescription Class Reference

Service class for formatting the descriptions of the various class instances. More...

#import <SCDescription.h>

Inheritance diagram for SCDescription:

Formatting Descriptions of the Class Instances
(NSString *)	+ stringWithObject:level:
(NSString *)	+ stringWithString:level:
(NSString *)	+ stringWithNumber:level:
(NSString *)	+ stringWithBool:level:
(NSString *)	+ stringWithChar:level:
(NSString *)	+ stringWithUnichar:level:
(NSString *)	+ stringWithDate:level:
(NSString *)	+ stringWithData:level:
(NSString *)	+ stringWithNull:level:
(NSString *)	+ stringWithArray:level:
(NSString *)	+ stringWithSet:level:
(NSString *)	+ stringWithOrderedSet:level:
(NSString *)	+ stringWithDictionary:level:
(NSString *)	+ stringWithStack:level:
(NSString *)	+ stringWithQueue:level:
(NSString *)	+ stringWithList:level:
(NSString *)	+ stringWithCollection:level:
(NSString *)	+ stringWithFoundationArray:level:
(NSString *)	+ stringWithFoundationSet:level:
(NSString *)	+ stringWithFoundationOrderedSet:level:
(NSString *)	+ stringWithFoundationDictionary:level:

Additional Inherited Members
Instance Methods inherited from 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:
(id)	- copyObject
(SCComparisonResult)	- compareWithObject:
(BOOL)	- isEqual:
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data
Properties inherited from SCObject
NSString *	className

Detailed Description

Service class for formatting the descriptions of the various class instances.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.2.1

Declares the methods for creating a formatted descriptions of the instances of the various classes.

Method Documentation

+ (NSString *) stringWithArray:		(SCArray *)	array
level:		(SCUInteger)	level

Returns a description of the specified library array.

Parameters

array	- the source library array
level	- the level of the description

Returns

A library array description

+ (NSString *) stringWithBool:		(BOOL)	boolean
level:		(SCUInteger)	level

Returns a description of the specified boolean value.

Parameters

boolean	- the source boolean value
level	- the level of the description

Returns

A boolean value description

+ (NSString *) stringWithChar:		(unsigned char)	character
level:		(SCUInteger)	level

Returns a description of the specified character.

Parameters

character	- the source character
level	- the level of the description

Returns

A character description

See also

+ stringWithUnichar:level:

+ (NSString *) stringWithCollection:		(id<SCCollection>)	collection
level:		(SCUInteger)	level

Returns a description of the specified collection of any supported type.

Parameters

collection	- the source collection
level	- the level of the description

Returns

A collection description

+ (NSString *) stringWithData:		(NSData *)	data
level:		(SCUInteger)	level

Returns a description of the specified NSData object.

Parameters

data	- the source object
level	- the level of the description

Returns

An object description

+ (NSString *) stringWithDate:		(NSDate *)	date
level:		(SCUInteger)	level

Returns a description of the specified date.

Parameters

date	- the source date
level	- the level of the description

Returns

A date description

+ (NSString *) stringWithDictionary:		(SCDictionary *)	dictionary
level:		(SCUInteger)	level

Returns a description of the specified library dictionary.

Parameters

dictionary	- the source library dictionary
level	- the level of the description

Returns

A library dictionary description

+ (NSString *) stringWithFoundationArray:		(NSArray *)	foundationArray
level:		(SCUInteger)	level

Returns a description of the specified foundation array.

Parameters

foundationArray	- the source foundation array
level	- the level of the description

Returns

A foundation array description

+ (NSString *) stringWithFoundationDictionary:		(NSDictionary *)	foundationDictionary
level:		(SCUInteger)	level

Returns a description of the specified foundation dictionary.

Parameters

foundationDictionary	- the source foundation dictionary
level	- the level of the description

Returns

A foundation dictionary description

+ (NSString *) stringWithFoundationOrderedSet:		(NSOrderedSet *)	foundationOrderedSet
level:		(SCUInteger)	level

Returns a description of the specified foundation ordered set.

Parameters

foundationOrderedSet	- the source foundation ordered set
level	- the level of the description

Returns

A foundation ordered set description

+ (NSString *) stringWithFoundationSet:		(NSSet *)	foundationSet
level:		(SCUInteger)	level

Returns a description of the specified foundation set.

Parameters

foundationSet	- the source foundation set
level	- the level of the description

Returns

A foundation set description

+ (NSString *) stringWithList:		(SCList *)	list
level:		(SCUInteger)	level

Returns a description of the specified list.

Parameters

list	- the source list
level	- the level of the description

Returns

A list description

+ (NSString *) stringWithNull:		(NSNull *)	null
level:		(SCUInteger)	level

Returns a description of the specified NSNull object.

Parameters

null	- the source object
level	- the level of the description

Returns

An object description

+ (NSString *) stringWithNumber:		(NSNumber *)	number
level:		(SCUInteger)	level

Returns a description of the specified number.

Parameters

number	- the source number
level	- the level of the description

Returns

A number description

+ (NSString *) stringWithObject:		(id)	object
level:		(SCUInteger)	level

Returns a description of the specified class instance.

Parameters

object	- the class instance
level	- the level of the description

Returns

A class instance description

+ (NSString *) stringWithOrderedSet:		(SCOrderedSet *)	orderedSet
level:		(SCUInteger)	level

Returns a description of the specified library ordered set.

Parameters

orderedSet	- the source library ordered set
level	- the level of the description

Returns

A librray ordered set description

+ (NSString *) stringWithQueue:		(SCQueue *)	queue
level:		(SCUInteger)	level

Returns a description of the specified queue.

Parameters

queue	- the source queue
level	- the level of the description

Returns

A queue description

+ (NSString *) stringWithSet:		(SCSet *)	set
level:		(SCUInteger)	level

Returns a description of the specified library set.

Parameters

set	- the source library set
level	- the level of the description

Returns

A library set description

+ (NSString *) stringWithStack:		(SCStack *)	stack
level:		(SCUInteger)	level

Returns a description of the specified stack.

Parameters

stack	- the source stack
level	- the level of the description

Returns

A stack description

+ (NSString *) stringWithString:		(NSString *)	string
level:		(SCUInteger)	level

Returns a description of the specified string.

Parameters

string	- the source string
level	- the level of the description

Returns

A string description

+ (NSString *) stringWithUnichar:		(unichar)	character
level:		(SCUInteger)	level

Returns a description of the specified character.

Parameters

character	- the source character
level	- the level of the description

Returns

A character description

See also

+ stringWithChar:level:

---

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

• SCDescription.h
• SCDescription.m