com.github.dm.jrt.builder.ProxyConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation
Show all versions of jroutine Show documentation
Parallel programming on the go
/*
* 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.builder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
/**
* Class storing the proxy configuration.
*
* Each instance is immutable, thus, in order to modify a configuration parameter, a new builder
* must be created starting from the specific configuration.
*
* The configuration has a list of shared fields associated. Every method accessing a specific
* set of fields is protected so that the related variables can be accessed in a thread safe way.
* By default all fields are protected.
* Note however that methods sharing the same fields cannot be executed in parallel.
*
* Created by davide-maestroni on 04/20/2015.
*/
public final class ProxyConfiguration {
private static final DefaultConfigurable sDefaultConfigurable = new DefaultConfigurable();
/**
* Empty configuration constant.
The configuration has all the options set to their default.
*/
public static final ProxyConfiguration DEFAULT_CONFIGURATION = builder().buildConfiguration();
private final List mFieldNames;
/**
* Constructor.
*
* @param fieldNames the shared field names.
*/
private ProxyConfiguration(@Nullable final List fieldNames) {
mFieldNames = fieldNames;
}
/**
* Returns a proxy configuration builder.
*
* @return the builder.
*/
@NotNull
public static Builder builder() {
return new Builder(sDefaultConfigurable);
}
/**
* Returns a proxy configuration builder initialized with the specified configuration.
*
* @param initialConfiguration the initial proxy configuration.
* @return the builder.
*/
@NotNull
public static Builder builderFrom(
@Nullable final ProxyConfiguration initialConfiguration) {
return (initialConfiguration == null) ? builder()
: new Builder(sDefaultConfigurable, initialConfiguration);
}
/**
* Returns a proxy configuration builder initialized with this configuration.
*
* @return the builder.
*/
@NotNull
public Builder builderFrom() {
return builderFrom(this);
}
/**
* Returns the shared field names (null by default).
*
* @param valueIfNotSet the default value if none was set.
* @return the field names.
*/
public List getSharedFieldsOr(@Nullable final List valueIfNotSet) {
final List fieldNames = mFieldNames;
return (fieldNames != null) ? fieldNames : valueIfNotSet;
}
@Override
public int hashCode() {
// AUTO-GENERATED CODE
return mFieldNames != null ? mFieldNames.hashCode() : 0;
}
@Override
public boolean equals(final Object o) {
// AUTO-GENERATED CODE
if (this == o) {
return true;
}
if (!(o instanceof ProxyConfiguration)) {
return false;
}
final ProxyConfiguration that = (ProxyConfiguration) o;
return !(mFieldNames != null ? !mFieldNames.equals(that.mFieldNames)
: that.mFieldNames != null);
}
@Override
public String toString() {
// AUTO-GENERATED CODE
return "ProxyConfiguration{" +
"mFieldNames='" + mFieldNames + '\'' +
'}';
}
/**
* Interface defining a configurable object.
*
* @param the configurable object type.
*/
public interface Configurable {
/**
* Sets the specified configuration and returns the configurable instance.
*
* @param configuration the configuration.
* @return the configurable instance.
*/
@NotNull
TYPE setConfiguration(@NotNull ProxyConfiguration configuration);
}
/**
* Builder of proxy configurations.
*
* @param the configurable object type.
*/
public static final class Builder {
private final Configurable mConfigurable;
private List mFieldNames;
/**
* Constructor.
*
* @param configurable the configurable instance.
*/
@SuppressWarnings("ConstantConditions")
public Builder(@NotNull final Configurable configurable) {
if (configurable == null) {
throw new NullPointerException("the configurable instance must no be null");
}
mConfigurable = configurable;
}
/**
* Constructor.
*
* @param configurable the configurable instance.
* @param initialConfiguration the initial proxy configuration.
*/
@SuppressWarnings("ConstantConditions")
public Builder(@NotNull final Configurable configurable,
@NotNull final ProxyConfiguration initialConfiguration) {
if (configurable == null) {
throw new NullPointerException("the configurable instance must no be null");
}
mConfigurable = configurable;
setConfiguration(initialConfiguration);
}
/**
* Sets the configuration and returns the configurable object.
*
* @return the configurable object.
*/
@NotNull
public TYPE set() {
return mConfigurable.setConfiguration(buildConfiguration());
}
/**
* Applies the specified configuration to this builder. A null value means that all the
* configuration options need to be set to their default value, otherwise only the set
* options will be applied.
*
* @param configuration the proxy configuration.
* @return this builder.
*/
@NotNull
public Builder with(@Nullable final ProxyConfiguration configuration) {
if (configuration == null) {
setConfiguration(DEFAULT_CONFIGURATION);
return this;
}
final List fieldNames = configuration.mFieldNames;
if (fieldNames != null) {
withSharedFields(fieldNames);
}
return this;
}
/**
* Sets the shared field names to empty, that is, no field is shared.
*
* @return this builder.
*/
@NotNull
public Builder withSharedFields() {
mFieldNames = Collections.emptyList();
return this;
}
/**
* Sets the shared field names. A null value means that all fields are shared.
*
* @param fieldNames the field names.
* @return this builder.
*/
@NotNull
public Builder withSharedFields(@Nullable final String... fieldNames) {
mFieldNames = (fieldNames != null) ? Arrays.asList(fieldNames) : null;
return this;
}
/**
* Sets the shared field names. A null value means that all fields are shared.
*
* @param fieldNames the field names.
* @return this builder.
*/
@NotNull
public Builder withSharedFields(@Nullable final List fieldNames) {
mFieldNames = (fieldNames != null) ? Collections.unmodifiableList(
new ArrayList(fieldNames)) : null;
return this;
}
@NotNull
private ProxyConfiguration buildConfiguration() {
return new ProxyConfiguration(mFieldNames);
}
private void setConfiguration(@NotNull final ProxyConfiguration configuration) {
mFieldNames = configuration.mFieldNames;
}
}
/**
* Default configurable implementation.
*/
private static class DefaultConfigurable implements Configurable {
@NotNull
public ProxyConfiguration setConfiguration(
@NotNull final ProxyConfiguration configuration) {
return configuration;
}
}
}