Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol.runtime
Class ToStringHelper

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.runtime.ToStringHelper

public class ToStringHelper
extends java.lang.Object

Helper class for msg.toString() implementation.


Method Summary
static LogHiddenAttributes.AttributeSet getHiddenAttributes(java.lang.String protocolName, java.lang.String attributeHolderName)
          Gets hidden attribute set.
static void hideAttribute(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Hide message attribute from msg.toString() output.
static boolean isLogHidden(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Check if attribute is hidden from msg.toString() output.
static void setHiddenAttributes(LogHiddenAttributes config)
          Applies new hidden attributes configuration.
static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val)
          For internal usage.
static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val, boolean truncate, boolean hideAllowed)
          For internal usage.
static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val, boolean truncate, boolean hideAllowed, int indent)
          For internal usage.
static java.lang.String toString(Message msg)
          For internal usage.
static java.lang.String toString(Message msg, boolean hideAllowed, boolean truncate)
          For internal usage.
static void unhideAttribute(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Unhide message attribute from msg.toString() output.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

hideAttribute

public static void hideAttribute(java.lang.String protocolName,
                                 java.lang.String attributeHolderName,
                                 java.lang.String attributeName)
                          throws java.lang.NullPointerException
Hide message attribute from msg.toString() output. Example: ToStringHelper.hideAttribute("ContactServer", "InteractionContent", "Text")

Parameters:
protocolName - name of the protocol, i.e. value returned by protocolDescription.getProtocolName()
attributeHolderName - name of the protocol message (i.e. "EventInfo") or complex message attribute name. Supported complex attributes: attributes that extend CompoundValue or AbstractPrintable
attributeName - attribute name
Throws:
java.lang.NullPointerException - if protocolName, className, attributeName is null

unhideAttribute

public static void unhideAttribute(java.lang.String protocolName,
                                   java.lang.String attributeHolderName,
                                   java.lang.String attributeName)
                            throws java.lang.NullPointerException
Unhide message attribute from msg.toString() output. Example: ToStringHelper.unhideAttribute("ContactServer", "InteractionContent", "Text")

Parameters:
protocolName - name of the protocol, i.e. value returned by protocolDescription.getProtocolName()
attributeHolderName - name of the protocol message (i.e. "EventInfo") or complex message attribute name. Supported complex attributes: attributes that extend CompoundValue or AbstractPrintable
attributeName - attribute name
Throws:
java.lang.NullPointerException - if protocolName, className, attributeName is null

setHiddenAttributes

public static void setHiddenAttributes(LogHiddenAttributes config)
Applies new hidden attributes configuration.

Parameters:
settings - hidden attributes configuration

isLogHidden

public static boolean isLogHidden(java.lang.String protocolName,
                                  java.lang.String attributeHolderName,
                                  java.lang.String attributeName)
Check if attribute is hidden from msg.toString() output.

Parameters:
protocolName - name of the protocol, i.e. value returned by protocolDescription.getProtocolName()
attributeHolderName - Name of the protocol message or complex message attribute. Supported complex attributes: attributes that extend CompoundValue or AbstractPrintable
attributeName - attribute name
Returns:

getHiddenAttributes

public static LogHiddenAttributes.AttributeSet getHiddenAttributes(java.lang.String protocolName,
                                                                   java.lang.String attributeHolderName)
Gets hidden attribute set. For internal usage.


toString

public static java.lang.String toString(Message msg)
For internal usage.


toString

public static java.lang.String toString(Message msg,
                                        boolean hideAllowed,
                                        boolean truncate)
For internal usage.


toString

public static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val)
For internal usage.


toString

public static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val,
                                        boolean truncate,
                                        boolean hideAllowed)
For internal usage.


toString

public static java.lang.String toString(com.genesyslab.platform.commons.protocol.runtime.CompoundValue val,
                                        boolean truncate,
                                        boolean hideAllowed,
                                        int indent)
For internal usage.


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.