io.brackit.query.module.AbstractModule Maven / Gradle / Ivy

Go to download
/*
 * [New BSD License]
 * Copyright (c) 2011-2012, Brackit Project Team 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Brackit Project Team nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package io.brackit.query.module;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import io.brackit.query.atomic.QNm;
import io.brackit.query.atomic.Str;

/**
 * @author Sebastian Baechle
 */
public abstract class AbstractModule implements Module {

  // use small lists instead of maps because we assume
  // relatively few module imports, external variables and options
  // per module and also relatively few lookups
  protected final List modules = new ArrayList<>();
  protected final Map options = new HashMap<>();
  protected final ModuleContext context = new ModuleContext();
  protected final Variables variables = new Variables();

  @Override
  public void importModule(Module module) {
    modules.add(module);
  }

  @Override
  public Variables getVariables() {
    return variables;
  }

  @Override
  public List getImportedModules() {
    return Collections.unmodifiableList(modules);
  }

  @Override
  public void addOption(QNm name, Str value) {
    options.put(name, value);
  }

  @Override
  public Map getOptions() {
    return Collections.unmodifiableMap(options);
  }

  @Override
  public StaticContext getStaticContext() {
    return context;
  }
}