Platform SDK Java 8.5 API Reference

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

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

public final class LogHiddenAttributes
extends java.lang.Object

Container for the hidden attributes, i.e. attributes that excluded from msg.toString() output. Use with ToStringHelper.setHiddenAttributes(LogHiddenAttributes config); to replace entire hidden attributes configuration with new one.


Nested Class Summary
static class LogHiddenAttributes.AttributeSet
          Hidden attribute set.
 
Constructor Summary
LogHiddenAttributes()
           
 
Method Summary
 LogHiddenAttributes.AttributeSet getHiddenSet(java.lang.String protocolName, java.lang.String className)
          Gets hidden attribute set.
 void hide(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Adds hidden attribute.
 boolean isLogHidden(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Check if attribute is hidden from msg.toString() output.
 void setHiddenAttributes(java.lang.String protocolName, java.lang.String attributeHolderName, java.util.Set<java.lang.String> attributes)
          Sets new hidden attributes for the specified protocol and message (or complex attribute) Specify empty list to unhide all attributes for the specified type
 void unhide(java.lang.String protocolName, java.lang.String attributeHolderName, java.lang.String attributeName)
          Removes hidden attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LogHiddenAttributes

public LogHiddenAttributes()
Method Detail

hide

public void hide(java.lang.String protocolName,
                 java.lang.String attributeHolderName,
                 java.lang.String attributeName)
          throws java.lang.NullPointerException
Adds hidden attribute.

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, attributeHolderName, attributeName is null

unhide

public void unhide(java.lang.String protocolName,
                   java.lang.String attributeHolderName,
                   java.lang.String attributeName)
            throws java.lang.NullPointerException
Removes hidden attribute.

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, attributeHolderName, attributeName is null

setHiddenAttributes

public void setHiddenAttributes(java.lang.String protocolName,
                                java.lang.String attributeHolderName,
                                java.util.Set<java.lang.String> attributes)
                         throws java.lang.NullPointerException
Sets new hidden attributes for the specified protocol and message (or complex attribute) Specify empty list to unhide all attributes for the specified type

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 extends CompoundValue or AbstractPrintable
attributes - attributes set
Throws:
java.lang.NullPointerException - if protocolName or attributeHolderName is null

isLogHidden

public 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 extends CompoundValue or AbstractPrintable
attributeName - attribute name
Returns:

getHiddenSet

public LogHiddenAttributes.AttributeSet getHiddenSet(java.lang.String protocolName,
                                                     java.lang.String className)
Gets hidden attribute set. 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.