Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration.log
Class SegmentationConfig

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.log.SegmentationConfig
All Implemented Interfaces:
java.io.Serializable

public final class SegmentationConfig
extends java.lang.Object
implements java.io.Serializable

Describes the rule of segmentation of log files.

See Also:
LogOptionsDescriptions.SEGMENT_OPT, Serialized Form

Nested Class Summary
static class SegmentationConfig.SegmentationStrategy
          Describes type of segmentation.
 
Field Summary
static SegmentationConfig DEFAULT_SEGMENTATION
           
static SegmentationConfig NO_SEGMENTATION
           
 
Constructor Summary
SegmentationConfig(SegmentationConfig.SegmentationStrategy theStrategy, int theSegment)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 int getSegment()
          Numeric value which meaning depends on the value of getStrategy().
 SegmentationConfig.SegmentationStrategy getStrategy()
          Describes the type of segmentation used.
 int hashCode()
           
static SegmentationConfig parse(java.lang.String optionVal, ILogger logger)
          Parses string option value in format of the segmentation option LogOptionsDescriptions.SEGMENT_OPT.
 java.lang.String toString()
          Returns readable string representation of the Segmentation option value.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_SEGMENTATION

public static final SegmentationConfig NO_SEGMENTATION

DEFAULT_SEGMENTATION

public static final SegmentationConfig DEFAULT_SEGMENTATION
Constructor Detail

SegmentationConfig

public SegmentationConfig(SegmentationConfig.SegmentationStrategy theStrategy,
                          int theSegment)
Constructor.

Parameters:
theStrategy - the value for getStrategy().
theSegment - the value for getSegment().
Method Detail

getStrategy

public SegmentationConfig.SegmentationStrategy getStrategy()
Describes the type of segmentation used.

Returns:
type of segmentation used

getSegment

public int getSegment()
Numeric value which meaning depends on the value of getStrategy().

Returns:
segment numeric value

parse

public static SegmentationConfig parse(java.lang.String optionVal,
                                       ILogger logger)
Parses string option value in format of the segmentation option LogOptionsDescriptions.SEGMENT_OPT.

Parameters:
optionVal - the option value for parsing.
logger - optional "status" logger for parsing errors printing.
Returns:
Parsed value of Segmentation configuration or null.
See Also:
LogOptionsDescriptions.SEGMENT_OPT

toString

public java.lang.String toString()
Returns readable string representation of the Segmentation option value.

Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

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.