#import <Foundation/Foundation.h>

#if TARGET_OS_IPHONE
    #import "DDXML.h"
#endif

/**
 * The XMPPResultSet class represents an <set xmlns='http://jabber.org/protocol/rsm'> element form XEP-0059.
 * It extends NSXMLElement.
 *
 * Calling resultSet on an NSXMLElement returns an XMPPResultSet if it exists (see NSXMLElement+XEP_0059.h)
 *
 * This class exists to provide developers an easy way to add functionality to Result Set processing.
 * Simply add your own category to XMPPResultSet to extend it with your own custom methods.
 *
 * XMPPResultSet uses NSNotFound to Specify undefined integer values i.e. max,firstIndex and count.
 * XMPPResultSet uses a NSString of 0 length but not nil to supply empty elements i.e. before and after.
 *
 * Example:
 *
 * To fetch the last 10 items in a result set you need the following XML:
 *
 * <set xmlns='http://jabber.org/protocol/rsm'>
 *  <max>10</max>
 *  <before/>
 * </set>
 *
 * This Result Set can be created by:
 *
 * [XMPPResultSet resultSetWithMax:10 firstIndex:NSNotFound after:nil before:@""];
**/

NS_ASSUME_NONNULL_BEGIN
@interface XMPPResultSet : NSXMLElement

/**
 * Converts an NSXMLElement to an XMPPResultSet element in place (no memory allocations or copying)
 **/
+ (XMPPResultSet *)resultSetFromElement:(NSXMLElement *)element;

/**
 * Creates and returns a new autoreleased XMPPResultSet element.
**/
+ (XMPPResultSet *)resultSet;

+ (XMPPResultSet *)resultSetWithMax:(NSInteger)max;

+ (XMPPResultSet *)resultSetWithMax:(NSInteger)max
                         firstIndex:(NSInteger)index;

+ (XMPPResultSet *)resultSetWithMax:(NSInteger)max
                              after:(nullable NSString *)after;

+ (XMPPResultSet *)resultSetWithMax:(NSInteger)max
                             before:(nullable NSString *)before;

+ (XMPPResultSet *)resultSetWithMax:(NSInteger)max
                         firstIndex:(NSInteger)firstIndex
                              after:(nullable NSString *)after
                             before:(nullable NSString *)before;


/**
 * Creates and returns a new XMPPResultSet element.
**/
- (instancetype)init;

- (instancetype)initWithMax:(NSInteger)max;

- (instancetype)initWithMax:(NSInteger)max
                 firstIndex:(NSInteger)firstIndex;

- (instancetype)initWithMax:(NSInteger)max
                      after:(nullable NSString *)after;

- (instancetype)initWithMax:(NSInteger)max
                     before:(nullable NSString *)before;

- (instancetype)initWithMax:(NSInteger)max
                 firstIndex:(NSInteger)firstIndex
                      after:(nullable NSString *)after
                     before:(nullable NSString *)before;


@property (nonatomic, readonly) NSInteger max;

@property (nonatomic, readonly) NSInteger firstIndex;

@property (nonatomic, readonly, nullable) NSString *after;
@property (nonatomic, readonly, nullable) NSString *before;

@property (nonatomic, readonly) NSInteger count;

@property (nonatomic, readonly, nullable) NSString *first;
@property (nonatomic, readonly, nullable) NSString *last;

@end
NS_ASSUME_NONNULL_END