Namespace: OpenEdge.Logging.Filter
Class
LogFilterBuilder
Parent classes:
Inherits: OpenEdge.Core.Util.ConfigBuilder

/* *************************************************************************************************************************
Copyright (c) 2016-2019 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:LogFilterBuilder
Purpose:Builder for Filter filters (writers, formatters)
Author(s):pjudge
Created:2016-11-14
Purpose: The filter being built




Method Summary
Options Name Purpose
OpenEdge.Logging.Filter.LogFilterBuilder Append (logical) /** Indicates whether to append to the log @param character The filename to write to @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Build (character) /** Returns log writer build for a logging type @param character The Filter type for which to build the logger @return LogFilterBuilder The entity writer builder to use */
OpenEdge.Logging.Filter.LogFilterBuilder Build (character, BuilderRegistry) /** Returns log writer build for a logging type. To find a filter builder, i. Look in the registry for the filter type. If not found, ii. Look for the default ('*') builder in the registry. If not found, iii. Use this type (LogFilterBuilder) @param character The Filter type for which to build the logger @param BuilderRegistry A registry of Filter writers to user @return LogFilterBuilder The entity writer builder to use */
OpenEdge.Logging.Filter.LogFilterBuilder Build (Class) /** Returns log writer build for a logging type @param P.L.Class The Filter type for which to build the logger @return LogFilterBuilder The entity writer builder to use */
OpenEdge.Logging.Filter.LogFilterBuilder FormatAs (character) /** Sets a format string for a filter @param character The filename to write to @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder FromRegistry (BuilderRegistry) /** Sets the logging level for the logger @param BuilderRegistry The registry containing the map of log writers @return LogFilterBuilder This builder object. */
Progress.Lang.Class GetFilterType (character) /** Returns a filter writer from a registry; either the optional one set via loggerFilterRegistry or the default LoggerFilterRegistry:Registry. It's the caller's responsibility to invoke and use the filter type returned. @param character The filter type name @return Progress.Lang.Class The type of the filter writer. */
OpenEdge.Logging.Filter.ILoggerFilter NewFilter () /* Creates the instance. @return ILoggerFilter A filter instance */
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, character) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param character The value of the option (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, decimal) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param decimal The value of the option (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, int64) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param int64 The value of the option (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, logical) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param logical The value of the option (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Option (character, Object) /** Adds or overwrites an option for the logger filter. @param character The name of the option @param Object The value of the option (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder Options (JsonObject) /** Adds or overwrites an option for the logger filter. @param JsonObject The Filter options (can be anything) @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (character) /** Sets the output destination @param character The filename to write to @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (FileOutputStream) /** Sets the output destination @param FileOutputStream The filename to write to @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (JsonArray) /** Sets the output destination @param JsonArray The object to write into to @return LogFilterBuilder This builder object. */
OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (OutputStream) /** Sets the output destination @param OutputStream The filename to write to @return LogFilterBuilder This builder object. */

Constructor Summary
Options Name Purpose
LogFilterBuilder (character) /* Constructor */

Property Summary
Options Name Purpose
OpenEdge.Logging.Filter.ILoggerFilter Filter
CHARACTER FilterType


Method Detail
Top

OpenEdge.Logging.Filter.LogFilterBuilder Append (logical)

Purpose: Indicates whether to append to the log
Parameters:
plAppendToLog LOGICAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Build (character)

Purpose: Returns log writer build for a logging type
Parameters:
pcFilterType CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

OpenEdge.Logging.Filter.LogFilterBuilder Build (character, BuilderRegistry)

Purpose: Returns log writer build for a logging type.
To find a filter builder,
i. Look in the registry for the filter type. If not found,
ii. Look for the default ('*') builder in the registry. If not found,
iii. Use this type (LogFilterBuilder)
Parameters:
pcFilterType CHARACTER
poWriters OpenEdge.Core.Util.BuilderRegistry
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

OpenEdge.Logging.Filter.LogFilterBuilder Build (Class)

Purpose: Returns log writer build for a logging type
Parameters:
pfilterType Progress.Lang.Class
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder The entity writer builder to use
Top

OpenEdge.Logging.Filter.LogFilterBuilder FormatAs (character)

Purpose: Sets a format string for a filter
Parameters:
pcFormat CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder FromRegistry (BuilderRegistry)

Purpose: Sets the logging level for the logger
Parameters:
poLoggerFilterRegistry OpenEdge.Core.Util.BuilderRegistry
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

Progress.Lang.Class GetFilterType (character)

Purpose: Returns a filter writer from a registry; either the optional one set via loggerFilterRegistry or
the default LoggerFilterRegistry:Registry. It's the caller's responsibility to invoke and
use the filter type returned.
Parameters:
filterTypeName CHARACTER
Returns Progress.Lang.Class
Progress.Lang.Class The type of the filter writer.
Top

OpenEdge.Logging.Filter.ILoggerFilter NewFilter ()

/* Creates the instance.
Returns OpenEdge.Logging.Filter.ILoggerFilter
ILoggerFilter A filter instance
Top

OpenEdge.Logging.Filter.LogFilterBuilder Option (character, character)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Option (character, decimal)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue DECIMAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Option (character, int64)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue INT64
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Option (character, logical)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue LOGICAL
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Option (character, Object)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
pName CHARACTER
pValue Progress.Lang.Object
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder Options (JsonObject)

Purpose: Adds or overwrites an option for the logger filter.
Parameters:
poValue Progress.Json.ObjectModel.JsonObject
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (character)

Purpose: Sets the output destination
Parameters:
pcLogFile CHARACTER
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (FileOutputStream)

Purpose: Sets the output destination
Parameters:
poLogFile Progress.IO.FileOutputStream
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (JsonArray)

Purpose: Sets the output destination
Parameters:
pLog Progress.Json.ObjectModel.JsonArray
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.
Top

OpenEdge.Logging.Filter.LogFilterBuilder WriteTo (OutputStream)

Purpose: Sets the output destination
Parameters:
poOutput Progress.IO.OutputStream
Returns OpenEdge.Logging.Filter.LogFilterBuilder
LogFilterBuilder This builder object.


Constructor Detail
Top

LogFilterBuilder (character)

/* Constructor
Parameters:
pcFilterType CHARACTER


Property Detail
Top

OpenEdge.Logging.Filter.ILoggerFilter Filter

Returns OpenEdge.Logging.Filter.ILoggerFilter
Top

CHARACTER FilterType

Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15