com.hubspot.imap.SocksProxyConfig Maven / Gradle / Ivy
package com.hubspot.imap;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.common.base.MoreObjects;
import com.google.common.net.HostAndPort;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.immutables.value.Generated;
/**
* Immutable implementation of {@link SocksProxyConfigIF}.
*
* Use the builder to create immutable instances:
* {@code SocksProxyConfig.builder()}.
*/
@Generated(from = "SocksProxyConfigIF", generator = "Immutables")
@SuppressWarnings({"all"})
@SuppressFBWarnings
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class SocksProxyConfig implements SocksProxyConfigIF {
private final HostAndPort proxyHost;
private SocksProxyConfig(HostAndPort proxyHost) {
this.proxyHost = proxyHost;
}
/**
* @return The value of the {@code proxyHost} attribute
*/
@JsonProperty("proxyHost")
@Override
public HostAndPort proxyHost() {
return proxyHost;
}
/**
* Copy the current immutable object by setting a value for the {@link SocksProxyConfigIF#proxyHost() proxyHost} attribute.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for proxyHost
* @return A modified copy of the {@code this} object
*/
public final SocksProxyConfig withProxyHost(HostAndPort value) {
if (this.proxyHost == value) return this;
HostAndPort newValue = Objects.requireNonNull(value, "proxyHost");
return new SocksProxyConfig(newValue);
}
/**
* This instance is equal to all instances of {@code SocksProxyConfig} that have equal attribute values.
* @return {@code true} if {@code this} is equal to {@code another} instance
*/
@Override
public boolean equals(@Nullable Object another) {
if (this == another) return true;
return another instanceof SocksProxyConfig
&& equalTo((SocksProxyConfig) another);
}
private boolean equalTo(SocksProxyConfig another) {
return proxyHost.equals(another.proxyHost);
}
/**
* Computes a hash code from attributes: {@code proxyHost}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + proxyHost.hashCode();
return h;
}
/**
* Prints the immutable value {@code SocksProxyConfig} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("SocksProxyConfig")
.omitNullValues()
.add("proxyHost", proxyHost)
.toString();
}
/**
* Utility type used to correctly read immutable object from JSON representation.
* @deprecated Do not use this type directly, it exists only for the Jackson-binding infrastructure
*/
@Generated(from = "SocksProxyConfigIF", generator = "Immutables")
@Deprecated
@SuppressWarnings("Immutable")
@JsonDeserialize
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json implements SocksProxyConfigIF {
@Nullable HostAndPort proxyHost;
@JsonProperty("proxyHost")
public void setProxyHost(HostAndPort proxyHost) {
this.proxyHost = proxyHost;
}
@Override
public HostAndPort proxyHost() { throw new UnsupportedOperationException(); }
}
/**
* @param json A JSON-bindable data structure
* @return An immutable value type
* @deprecated Do not use this method directly, it exists only for the Jackson-binding infrastructure
*/
@Deprecated
@JsonCreator(mode = JsonCreator.Mode.DELEGATING)
static SocksProxyConfig fromJson(Json json) {
SocksProxyConfig.Builder builder = SocksProxyConfig.builder();
if (json.proxyHost != null) {
builder.proxyHost(json.proxyHost);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link SocksProxyConfigIF} value.
* Uses accessors to get values to initialize the new immutable instance.
* If an instance is already immutable, it is returned as is.
* @param instance The instance to copy
* @return A copied immutable SocksProxyConfig instance
*/
public static SocksProxyConfig copyOf(SocksProxyConfigIF instance) {
if (instance instanceof SocksProxyConfig) {
return (SocksProxyConfig) instance;
}
return SocksProxyConfig.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link SocksProxyConfig SocksProxyConfig}.
*
* SocksProxyConfig.builder()
* .proxyHost(com.google.common.net.HostAndPort) // required {@link SocksProxyConfigIF#proxyHost() proxyHost}
* .build();
*
* @return A new SocksProxyConfig builder
*/
public static SocksProxyConfig.Builder builder() {
return new SocksProxyConfig.Builder();
}
/**
* Builds instances of type {@link SocksProxyConfig SocksProxyConfig}.
* Initialize attributes and then invoke the {@link #build()} method to create an
* immutable instance.
* {@code Builder} is not thread-safe and generally should not be stored in a field or collection,
* but instead used immediately to create instances.
*/
@Generated(from = "SocksProxyConfigIF", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_PROXY_HOST = 0x1L;
private long initBits = 0x1L;
private @Nullable HostAndPort proxyHost;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code SocksProxyConfigIF} instance.
* Regular attribute values will be replaced with those from the given instance.
* Absent optional values will not replace present values.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(SocksProxyConfigIF instance) {
Objects.requireNonNull(instance, "instance");
proxyHost(instance.proxyHost());
return this;
}
/**
* Initializes the value for the {@link SocksProxyConfigIF#proxyHost() proxyHost} attribute.
* @param proxyHost The value for proxyHost
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("proxyHost")
public final Builder proxyHost(HostAndPort proxyHost) {
this.proxyHost = Objects.requireNonNull(proxyHost, "proxyHost");
initBits &= ~INIT_BIT_PROXY_HOST;
return this;
}
/**
* Builds a new {@link SocksProxyConfig SocksProxyConfig}.
* @return An immutable instance of SocksProxyConfig
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public SocksProxyConfig build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new SocksProxyConfig(proxyHost);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_PROXY_HOST) != 0) attributes.add("proxyHost");
return "Cannot build SocksProxyConfig, some of required attributes are not set " + attributes;
}
}
}