src/com/facebook/buck/json/ProjectBuildFileParserFactory.java

/*
 * Copyright 2012-present Facebook, Inc.
 *
 * 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.facebook.buck.json;

/**
 * Simple concrete factory so that a parser can be constructed on demand of the parse phase
 * and be explicitly shut down afterward.
 */
public interface ProjectBuildFileParserFactory {
  /**
   * Construct a new parser on demand using the provided common project build files.
   *
   * @param commonIncludes Common build files to be imported into each build file parsed.
   * @return Parser instance.
   */
  public ProjectBuildFileParser createParser(Iterable<String> commonIncludes);
}