com.googlecode.wickedcharts.highcharts.options.processing.IOptionsProcessor Maven / Gradle / Ivy

Go to download
/**
 *   Copyright 2012-2013 Wicked Charts (http://wicked-charts.googlecode.com)
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package com.googlecode.wickedcharts.highcharts.options.processing;

import com.googlecode.wickedcharts.highcharts.options.Options;

/**
 * Interface for processing {@link Options} before they are renderer.
 * 
 * @author Tom Hombergs ([email protected])
 * 
 */
public interface IOptionsProcessor {

  /**
   * Processes the given {@link Options}. This method gives the opportunity to
   * modify an {@link Options} object before it is rendered as JSON.  This
   * class is not part of the public API!
   * 
   * @param options
   *          the {@link Options} to process or modify.
   * @param context
   *          the context containing some context variables that may be accessed
   *          and changed by the processor.
   */
  void processOptions(Options options, OptionsProcessorContext context);

}