From: Mukund Sivaraman <muks@isc.org>
Date: Wed, 4 Jul 2012 03:48:17 +0000 (+0530)
Subject: [2053] Make LabelSequence::toText(bool) a private method
X-Git-Tag: trac2351_base~207
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6c78bb408db659d97a4af548da504175a22bfabe;p=thirdparty%2Fkea.git

[2053] Make LabelSequence::toText(bool) a private method
---

diff --git a/src/lib/dns/labelsequence.h b/src/lib/dns/labelsequence.h
index 374e6c4978..7d8827e00f 100644
--- a/src/lib/dns/labelsequence.h
+++ b/src/lib/dns/labelsequence.h
@@ -41,6 +41,9 @@ namespace dns {
 /// data of the associated Name object).
 ///
 class LabelSequence {
+    // Name calls the private toText(bool) method of LabelSequence.
+    friend std::string Name::toText(bool) const;
+
 public:
     /// \brief Constructs a LabelSequence for the given name
     ///
@@ -127,7 +130,7 @@ public:
     ///
     /// This method returns a <code>std::string</code> object representing the
     /// LabelSequence as a string.  The returned string ends with a dot
-    /// '.' if <code>omit_final_dot</code> is <code>false</code>.
+    /// '.' if the label sequence is absolute.
     ///
     /// This function assumes the underlying name is in proper
     /// uncompressed wire format.  If it finds an unexpected label
@@ -136,26 +139,22 @@ public:
     /// allocation for the result string fails, a corresponding standard
     /// exception will be thrown.
     //
-    /// \param omit_final_dot whether to omit the trailing dot in the output.
     /// \return a string representation of the <code>LabelSequence</code>.
-    std::string toText(bool omit_final_dot) const;
+    std::string toText() const;
 
+private:
     /// \brief Convert the LabelSequence to a string.
     ///
-    /// This method returns a <code>std::string</code> object representing the
-    /// LabelSequence as a string.  The returned string ends with a dot
-    /// '.' if the label sequence is absolute.
+    /// This method is a version of the zero-argument toText() method,
+    /// that accepts a <code>omit_final_dot</code> argument. The
+    /// returned string ends with a dot '.' if
+    /// <code>omit_final_dot</code> is <code>false</code>.
     ///
-    /// This function assumes the underlying name is in proper
-    /// uncompressed wire format.  If it finds an unexpected label
-    /// character including compression pointer, an exception of class
-    /// \c BadLabelType will be thrown.  In addition, if resource
-    /// allocation for the result string fails, a corresponding standard
-    /// exception will be thrown.
-    //
+    /// \param omit_final_dot whether to omit the trailing dot in the output.
     /// \return a string representation of the <code>LabelSequence</code>.
-    std::string toText() const;
+    std::string toText(bool omit_final_dot) const;
 
+public:
     /// \brief Calculate a simple hash for the label sequence.
     ///
     /// This method calculates a hash value for the label sequence as binary