sdk/src/main/java/com/google/cloud/dataflow/sdk/options/PipelineOptionsRegistrar.java

/*
 * Copyright (C) 2015 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.cloud.dataflow.sdk.options;

import java.util.ServiceLoader;

/**
 * {@link PipelineOptions} creators have the ability to automatically have their
 * {@link PipelineOptions} registered with this SDK by creating a {@link ServiceLoader} entry
 * and a concrete implementation of this interface.
 * <p>
 * Note that automatic registration of any
 * {@link com.google.cloud.dataflow.sdk.options.PipelineOptions} requires users
 * conform to the limitations discussed on {@link PipelineOptionsFactory#register(Class)}.
 * <p>
 * It is optional but recommended to use one of the many build time tools such as
 * {@link com.google.auto.service.AutoService} to generate the necessary META-INF
 * files automatically.
 */
public interface PipelineOptionsRegistrar {
  Iterable<Class<? extends PipelineOptions>> getPipelineOptions();
}