com.jrockit.mc.rjmx.flr
Class RecordingSettingsBuilder

java.lang.Object
  com.jrockit.mc.rjmx.flr.RecordingSettingsBuilder

public class RecordingSettingsBuilder
extends java.lang.Object

This builder is used to build the settings required to change event type settings in the Flight Recorder.

Author:

Marcus Hirt

See Also:

IFlightRecorderService.start(Map, EventTypeSetting[]), IFlightRecorderService.updateEventSettings(IRecordingDescriptor, EventTypeSetting[])

Field Summary

static java.lang.String

RECORDING_SETTING_NS

Constructor Summary

RecordingSettingsBuilder()

Method Summary

EventTypeSetting[]	build()
RecordingSettingsBuilder	setOption(EventTypeMetadata propertyMetaData, OptionMetadata serverProperty, java.lang.Object value) Sets a certain event setting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RECORDING_SETTING_NS

public static final java.lang.String RECORDING_SETTING_NS

See Also:

Constant Field Values

Constructor Detail

RecordingSettingsBuilder

public RecordingSettingsBuilder()

Method Detail

setOption

public RecordingSettingsBuilder setOption(EventTypeMetadata propertyMetaData,
                                          OptionMetadata serverProperty,
                                          java.lang.Object value)
                                   throws FlightRecorderException

Sets a certain event setting.

Parameters:

propertyMetaData - the meta data reference pointing out the particular event type.

serverProperty - the meta data reference pointing out the particular option.

value - the value to set. The value needs to either be the same type as specified by the meta data, or a String known to be handled by the underlying converter framework.

Returns:

the RecordingSettingsBuilder, so that multiple calls to the builder can be chained.

Throws:

FlightRecorderException - if there was a problem setting the particular option.

build

public EventTypeSetting[] build()

Returns:

the EventTypeSetting[] represented by this builder.