Platform SDK Java 8.5 API Reference

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

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

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

This class is used for configuring the expiration of log files (and log segments).

See Also:
LogOptionsDescriptions.EXPIRE_OPT, Serialized Form

Nested Class Summary
static class ExpirationConfig.ExpirationStrategy
          Describes the possible type of log file expiration strategy.
 
Field Summary
static ExpirationConfig DEFAULT_EXPIRATION
           
static ExpirationConfig NO_EXPIRATION
           
 
Constructor Summary
ExpirationConfig(ExpirationConfig.ExpirationStrategy theStrategy, int theExpire)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 int getExpire()
          The meaning of this property depends on the value of getStrategy().
 ExpirationConfig.ExpirationStrategy getStrategy()
          The ExpirationConfig.ExpirationStrategy which describes the strategy of expiration.
 int hashCode()
           
static ExpirationConfig parse(java.lang.String optionVal, ILogger logger)
          Parses string option value in format of the expiration option LogOptionsDescriptions.EXPIRE_OPT.
 java.lang.String toString()
          Returns readable string representation of the Expiration option value.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_EXPIRATION

public static final ExpirationConfig NO_EXPIRATION

DEFAULT_EXPIRATION

public static final ExpirationConfig DEFAULT_EXPIRATION
Constructor Detail

ExpirationConfig

public ExpirationConfig(ExpirationConfig.ExpirationStrategy theStrategy,
                        int theExpire)
Constructor.

Parameters:
theStrategy - the expiration strategy.
theExpire - the expiration value.
Method Detail

getStrategy

public ExpirationConfig.ExpirationStrategy getStrategy()
The ExpirationConfig.ExpirationStrategy which describes the strategy of expiration.


getExpire

public int getExpire()
The meaning of this property depends on the value of getStrategy(). See ExpirationConfig.ExpirationStrategy for more details.


toString

public java.lang.String toString()
Returns readable string representation of the Expiration 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

parse

public static ExpirationConfig parse(java.lang.String optionVal,
                                     ILogger logger)
Parses string option value in format of the expiration option LogOptionsDescriptions.EXPIRE_OPT.

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

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.