Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging
Interface FileHeaderProvider

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
DefaultFileHeaderProvider

public interface FileHeaderProvider
extends java.lang.Cloneable

This interface describes the provider, used for obtaining the header of the log file or log file segment. Each implementation class should implement deep copy.


Method Summary
 void applyConfiguration(LogConfiguration configuration)
          This method is called on the copy of class, during the procedure of configuring logger.
 FileHeaderProvider clone()
          Creates and returns a copy of this object.
 java.lang.String getFileHeader(java.lang.String fileName)
          This method is called for obtaining the log file header.
 

Method Detail

applyConfiguration

void applyConfiguration(LogConfiguration configuration)
This method is called on the copy of class, during the procedure of configuring logger. The instance for which this method was called will be used for obtaining the header of file.

Parameters:
configuration - The configuration

getFileHeader

java.lang.String getFileHeader(java.lang.String fileName)
This method is called for obtaining the log file header.

Parameters:
fileName - The name of file to be written
Returns:
The string which will be used as header for the log file or segment

clone

FileHeaderProvider clone()
Creates and returns a copy of this object.

Returns:
a clone of this instance
See Also:
Cloneable

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.