CodebaseCreator.java

/*
 * Copyright (c) 2011 Google, 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.google.devtools.moe.client.codebase;

import java.util.Map;

/**
 * A CodebaseCreator allows us to create Codebases.
 *
 * <p>This may bundle an existing codebase, or check it out from source control.
 */
public abstract class CodebaseCreator {

  /**
   * Creates a Codebase.
   *
   * @param options options to affect the codebase creation.
   * @return the created Codebase
   * @throw CodebaseCreationError if we cannot create the Codebase.
   */
  public abstract Codebase create(Map<String, String> options) throws CodebaseCreationError;
}