com.github.dm.jrt.object.config.ObjectConfigurable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jroutine-object Show documentation

Parallel programming on the go

The newest version!

/*
 * Copyright 2016 Davide Maestroni
 *
 * 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.github.dm.jrt.object.config;

import com.github.dm.jrt.object.config.ObjectConfiguration.Builder;
import com.github.dm.jrt.object.config.ObjectConfiguration.Configurable;

import org.jetbrains.annotations.NotNull;

/**
 * Interface defining an object that can be configured through an object configuration.
 * 
 * Created by davide-maestroni on 05/01/2015.
 *
 * @param  the object type.
 */
public interface ObjectConfigurable extends Configurable {

  /**
   * Gets the object configuration builder related to the instance.
   * 

   * The configuration options not supported by the specific implementation might be ignored.
   * 
   * Note that the configuration builder must be initialized with the current configuration.
   *
   * @return the object configuration builder.
   */
  @NotNull
  Builder applyObjectConfiguration();
}