[#BloombergLP-balb-FileCleanerConfiguration]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::FileCleanerConfiguration
:relfileprefix: ../../
:mrdocs:

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>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/FileCleanerConfiguration/2constructor-08.adoc[`FileCleanerConfiguration`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balb/FileCleanerConfiguration/operator_assign.adoc[`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.
| xref:BloombergLP/balb/FileCleanerConfiguration/filePattern.adoc[`filePattern`] 
| Return a `const` reference to the file pattern attribute of this object.
| xref:BloombergLP/balb/FileCleanerConfiguration/maxFileAge.adoc[`maxFileAge`] 
| Return the maximum file age attribute of this object.
| xref:BloombergLP/balb/FileCleanerConfiguration/maxNumFiles.adoc[`maxNumFiles`] 
| Return the maximum number of files to keep attribute of this object.
| xref:BloombergLP/balb/FileCleanerConfiguration/minNumFiles.adoc[`minNumFiles`] 
| Return the minimum number of files to keep attribute of this object.
| xref:BloombergLP/balb/FileCleanerConfiguration/print.adoc[`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.
| xref:BloombergLP/balb/FileCleanerConfiguration/setFilePattern.adoc[`setFilePattern`] 
| Set the file pattern attribute of this object to the specified `filePattern`.
| xref:BloombergLP/balb/FileCleanerConfiguration/setMaxFileAge.adoc[`setMaxFileAge`] 
| Set the maximum file age attribute of this object to the specified `maxAge`.
| xref:BloombergLP/balb/FileCleanerConfiguration/setMaxNumFiles.adoc[`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()`.
| xref:BloombergLP/balb/FileCleanerConfiguration/setMinNumFiles.adoc[`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`.
| xref:BloombergLP/balb/FileCleanerConfiguration/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<FileCleanerConfiguration, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balb/operator_eq-046.adoc[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

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/operator_not_eq-00.adoc[`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.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#