SCQueue.h

Go to the documentation of this file.

//
//  SCQueue.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCCollection.h>

#define SCQueueClass @"SCQueue" ///< SCQueue class name

@interface SCQueue : SCCollection {
    NSMutableArray *fQueue;     // Queue items array
        BOOL fReusable;                 // Reusable flag
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Queue name property
@property (retain, getter=queueName, setter=setQueueName:) NSString *queueName;
// Reusable property
@property (assign, getter=isReusable, setter=setReusable:) BOOL isReusable;
#endif

#pragma mark -
#pragma mark Creating Queue

+ (SCQueue *)queueWithDataDictionary:(NSDictionary *)dictionary;

+ (SCQueue *)queueWithDataDictionaryFromFile:(NSString *)path;

+ (SCQueue *)queueWithCoder:(NSCoder *)coder;

+ (SCQueue *)queueWithContentsOfSerializedFile:(NSString *)path;

+ (SCQueue *)queueWithStream:(SCStream *)stream;

+ (SCQueue *)queueWithFileStream:(NSString *)path;

+ (SCQueue *)queue;

+ (SCQueue *)queueWithQueueName:(NSString *)name
                       capacity:(SCULong)capacity
                       reusable:(BOOL)reusable;

+ (SCQueue *)queueWithQueueName:(NSString *)name capacity:(SCULong)capacity;

+ (SCQueue *)queueWithQueueName:(NSString *)name;

+ (SCQueue *)queueWithCapacity:(SCULong)capacity reusable:(BOOL)reusable;

+ (SCQueue *)queueWithCapacity:(SCULong)capacity;

+ (SCQueue *)queueWithDelegate:(id<SCCollectionDelegate>)delegate;

+ (SCQueue *)queueWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

+ (SCQueue *)queueWithCollection:(id)collection;

+ (SCQueue *)queueWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

+ (SCQueue *)queueWithObject:(id)object;

+ (SCQueue *)queueWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

+ (SCQueue *)queueWithObjects:(id)object, ...;

+ (SCQueue *)queueWithQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Initializing Queue

- (id)init;

- (id)initWithQueueName:(NSString *)name capacity:(SCULong)capacity reusable:(BOOL)reusable;

- (id)initWithQueueName:(NSString *)name capacity:(SCULong)capacity;

- (id)initWithQueueName:(NSString *)name;

- (id)initWithCapacity:(SCULong)capacity reusable:(BOOL)reusable;

- (id)initWithCapacity:(SCULong)capacity;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

- (id)initWithCollection:(id)collection;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

- (id)initWithObject:(id)object;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

- (id)initWithObjects:(id)object, ...;

- (id)initWithQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Querying and Setting Queue Properties

- (NSString *)queueName;

- (BOOL)isReusable;

- (void)setQueueName:(NSString *)name;

- (void)setReusable:(BOOL)reusable;

#pragma mark -
#pragma mark Querying Queue

- (id)firstObject;

- (NSString *)firstString;

- (NSNumber *)firstNumber;

- (SCByte)firstByte;

- (SCUByte)firstUByte;

- (SCShort)firstShort;

- (SCUShort)firstUShort;

- (SCInteger)firstInteger;

- (SCUInteger)firstUInteger;

- (SCLong)firstLong;

- (SCULong)firstULong;

- (char)firstChar;

- (unichar)firstUnichar;

- (const char *)firstCharString;

- (BOOL)firstBool;

- (SCFloat)firstFloat;

- (SCDouble)firstDouble;

#pragma mark -
#pragma mark Getting and Removing Objects

- (id)getAndRemoveObject;

- (NSString *)getAndRemoveString;

- (NSNumber *)getAndRemoveNumber;

- (SCByte)getAndRemoveByte;

- (SCUByte)getAndRemoveUByte;

- (SCShort)getAndRemoveShort;

- (SCUShort)getAndRemoveUShort;

- (SCInteger)getAndRemoveInteger;

- (SCUInteger)getAndRemoveUInteger;

- (SCLong)getAndRemoveLong;

- (SCULong)getAndRemoveULong;

- (char)getAndRemoveChar;

- (unichar)getAndRemoveUnichar;

- (const char *)getAndRemoveCharString;

- (BOOL)getAndRemoveBool;

- (SCFloat)getAndRemoveFloat;

- (SCDouble)getAndRemoveDouble;

#pragma mark -
#pragma mark Removing Objects

- (void)removeFirstObject;

- (void)removeLastObject;

#pragma mark -
#pragma mark Copying Objects

- (void)duplicateFirstObject;

- (void)duplicateLastObject;

@end