All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
TrimPipe.h
Go to the documentation of this file.
1 // Copyright 2015 Thomas Trapp
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef HEXT_TRIM_PIPE_H_INCLUDED
16 #define HEXT_TRIM_PIPE_H_INCLUDED
17 
18 /// @file
19 /// Declares hext::TrimPipe
20 
21 #include "hext/Cloneable.h"
22 #include "hext/StringPipe.h"
23 
24 #include <string>
25 
26 
27 namespace hext {
28 
29 
30 /// Trims characters from the beginning and end of a string. Trims space by
31 /// default.
32 class TrimPipe final : public hext::Cloneable<TrimPipe, StringPipe>
33 {
34 public:
35  /// Constructs a TrimPipe.
36  ///
37  /// @param trim_any_of: Trim any of these characters from beginning or end
38  /// of the string. Default: Trim spaces.
39  explicit TrimPipe(std::string trim_any_of = " ");
40 
41  /// Removes all left and right characters that were given in the constructor
42  /// from str.
43  std::string transform(std::string str) const override;
44 
45 private:
46  std::string trim_any_of_;
47 };
48 
49 
50 } // namespace hext
51 
52 
53 #endif // HEXT_TRIM_PIPE_H_INCLUDED
54 
Declares hext::StringPipe.
Trims characters from the beginning and end of a string.
Definition: TrimPipe.h:32
Curiously recurring template pattern that extends a base class to provide a virtual method Cloneable:...
Definition: Cloneable.h:34
std::string transform(std::string str) const override
Removes all left and right characters that were given in the constructor from str.
Defines template hext::Cloneable.
TrimPipe(std::string trim_any_of=" ")
Constructs a TrimPipe.