BloombergLP::balb::FileCleanerConfiguration

This simply constrained (value-semantic) attribute class characterizes configuration parameters for a file cleaner. See the for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

Synopsis

Declared in <balb_filecleanerconfiguration.h>

class FileCleanerConfiguration;

Description

This class: * supports a complete set of value-semantic operations

  • except for bdex serialization * is exception-neutral (agnostic) * is alias-safe * is const thread-safe For terminology see bsldoc_glossary.

Member Functions

NameDescription
FileCleanerConfiguration [constructor]Constructors
operator= Assign to this file cleaner configuration object the in-core value of the specified rhs object, and return a reference providing modifiable access to this object.
filePattern Return a const reference to the file pattern attribute of this object.
maxFileAge Return the maximum file age attribute of this object.
maxNumFiles Return the maximum number of files to keep attribute of this object.
minNumFiles Return the minimum number of files to keep attribute of this object.
print Format a reasonable representation of this object to the specified output stream at the (absolute value of) the optionally specified indentation level and return a reference to stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, suppress all indentation AND format the entire output on one line. If stream is not valid on entry, this operation has no effect.
setFilePattern Set the file pattern attribute of this object to the specified filePattern.
setMaxFileAge Set the maximum file age attribute of this object to the specified maxAge.
setMaxNumFiles Set the maximum number of files to keep attribute of this object to the specified maxNumFiles. The behavior is undefined if maxNumFiles < 0 or maxNumFiles < minNumFiles().
setMinNumFiles Set the minimum number of files to keep attribute of this object to the specified minNumFiles. The behavior is undefined if minNumFiles < 0 or maxNumFiles() < minNumFiles.
operator BloombergLP::bslmf::NestedTraitDeclaration<FileCleanerConfiguration, UsesBslmaAllocator> Declare that this type uses a bslma allocator.

Friends

NameDescription
BloombergLP::balb::operator==Return true if the specified lhs and rhs attribute objects have the same (in-core) value, and false otherwise. Two attribute objects have the same in-core value if each respective attribute has the same in-core value.

Non-Member Functions

NameDescription
operator!=Return true if the specified lhs and rhs attribute objects do not have the same (in-core) value, and false otherwise. Two attribute objects do not have the same in-core value if one or more respective attributes differ in in-core values.