Class MoreObjects.ToStringHelper

    • Method Detail

      • omitEmptyValues

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper omitEmptyValues()
        Configures the MoreObjects.ToStringHelper so toString() will ignore properties with empty values. The order of calling this method, relative to the add()/ addValue() methods, is not significant.

        Note: in general, code should assume that the string form returned by ToStringHelper for a given object may change. In particular, the list of types which are checked for emptiness is subject to change. We currently check CharSequences, Collections, Maps, optionals (including Guava's), and arrays.

        Since:
        33.4.0
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              @Nullable java.lang.Object value)
        Adds a name/value pair to the formatted output in name=value format. If value is null, the string "null" is used, unless omitNullValues() is called, in which case this name/value pair will not be added.
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              boolean value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              char value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              double value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              float value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              int value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • add

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper add​(java.lang.String name,
                                              long value)
        Adds a name/value pair to the formatted output in name=value format.
        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.add()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(boolean value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, boolean) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(char value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, char) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(double value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, double) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(float value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, float) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(int value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, int) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • addValue

        @CanIgnoreReturnValue
        public MoreObjects.ToStringHelper addValue​(long value)
        Adds an unnamed value to the formatted output.

        It is strongly encouraged to use add(String, long) instead and give value a readable name.

        Since:
        18.0 (since 11.0 as Objects.ToStringHelper.addValue()).
      • toString

        public java.lang.String toString()
        Returns a string in the format specified by MoreObjects.toStringHelper(Object).

        After calling this method, you can keep adding more properties to later call toString() again and get a more complete representation of the same object; but properties cannot be removed, so this only allows limited reuse of the helper instance. The helper allows duplication of properties (multiple name/value pairs with the same name can be added).

        Overrides:
        toString in class java.lang.Object