/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
* Jonathan Schleifer <js@heap.zone>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFException.h"
#import "OFFileManager.h"
OF_ASSUME_NONNULL_BEGIN
/*!
* @class OFSetItemAttributesFailedException \
* OFSetItemAttributesFailedException.h \
* ObjFW/OFSetItemAttributesFailedException.h
*
* @brief An exception indicating an item's attributes could not be set.
*/
@interface OFSetItemAttributesFailedException: OFException
{
OFString *_path;
of_file_attributes_t _attributes;
of_file_attribute_key_t _failedAttribute;
int _errNo;
}
/*!
* A string with the path of the item whose attributes could not be set.
*/
@property (readonly, nonatomic) OFString *path;
/*!
* The errno of the error that occurred.
*/
@property (readonly, nonatomic) int errNo;
/*!
* The attributes that should have been set.
*/
@property (readonly, nonatomic) of_file_attributes_t attributes;
/*!
* The first attribute that could not be set.
*/
@property (readonly, nonatomic) of_file_attribute_key_t failedAttribute;
+ (instancetype)exception OF_UNAVAILABLE;
/*!
* @brief Creates a new, autoreleased set item attributes failed exception.
*
* @param path A string with the path of the item whose attributes could not be
* set
* @param attributes The attributes that should have been set for the specified
* item.
* @param failedAttribute The first attribute that could not be set
* @param errNo The errno of the error that occurred
* @return A new, autoreleased set item attributes failed exception
*/
+ (instancetype)exceptionWithPath: (OFString *)path
attributes: (of_file_attributes_t)attributes
failedAttribute: (of_file_attribute_key_t)failedAttribute
errNo: (int)errNo;
- (instancetype)init OF_UNAVAILABLE;
/*!
* @brief Initializes an already allocated set item attributes failed exception.
*
* @param path A string with the path of the item whose attributes could not be
* set
* @param attributes The attributes that should have been set for the specified
* item.
* @param failedAttribute The first attribute that could not be set
* @param errNo The errno of the error that occurred
* @return An initialized set item attributes failed exception
*/
- (instancetype)initWithPath: (OFString *)path
attributes: (of_file_attributes_t)attributes
failedAttribute: (of_file_attribute_key_t)failedAttribute
errNo: (int)errNo OF_DESIGNATED_INITIALIZER;
@end
OF_ASSUME_NONNULL_END