SCQueue.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/NSArray+SCArray.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCQueueClass    @"SCQueue"


@interface SCQueue : SCCollection {
    NSMutableArray *_queue; // Internal data storage
}

@property (nonatomic, readonly, assign) id firstObject;

#pragma mark -
#pragma mark Creating Queues
+ (instancetype)queueWithCoder:(NSCoder *)coder;
+ (instancetype)queueWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)queueWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)queueWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)queueWithStream:(SCStream *)stream;
+ (instancetype)queueWithFileStream:(NSString *)path;
+ (instancetype)queueWithData:(NSData *)data;
+ (instancetype)queueWithContentsOfFile:(NSString *)path;
+ (instancetype)queueWithContentsOfURL:(NSURL *)url;
+ (instancetype)queueWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)queueWithName:(NSString *)name;
+ (instancetype)queueWithObject:(id<SCCollectioning>)object;
+ (instancetype)queueWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)queueWithCollection:(id<SCCollection>)collection;
+ (instancetype)queueWithArray:(SCArray *)array;
+ (instancetype)queueWithQueue:(SCQueue *)queue;
+ (instancetype)queue;

#pragma mark -
#pragma mark Initializing Queues
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithArray:(SCArray *)array;
- (instancetype)initWithQueue:(SCQueue *)queue;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Queues
- (void)setQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Comparing Queues
- (BOOL)isEqualToQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Deriving New Queues
- (SCQueue *)queueByAddingObject:(id<SCCollectioning>)object;
- (SCQueue *)queueByAddingObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (SCQueue *)queueByAddingCollection:(id<SCCollection>)collection;
- (SCQueue *)queueByAddingObjectsFromArray:(SCArray *)array;
- (SCQueue *)queueByAddingArray:(SCArray *)array;
- (SCQueue *)queueByAddingObjectsFromQueue:(SCQueue *)queue;
- (SCQueue *)queueByAddingQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Adding Objects
- (void)addObjectsFromArray:(SCArray *)array;
- (void)addArray:(SCArray *)array;
- (void)addObjectsFromQueue:(SCQueue *)queue;
- (void)addQueue:(SCQueue *)queue;

#pragma mark -
#pragma mark Getting Objects
- (id)getObject;

#pragma mark -
#pragma mark Removing Objects
- (void)removeFirstObject;
- (void)removeLastObject;

#pragma mark -
#pragma mark Copying Objects
- (void)duplicateFirstObject;
- (void)duplicateLastObject;

@end