io.grpc.ResolvedServerInfoGroup Maven / Gradle / Ivy
/*
* Copyright 2016, gRPC Authors All rights reserved.
*
* 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 io.grpc;
import static com.google.guava4pingcap.base.Preconditions.checkArgument;
import static com.google.guava4pingcap.base.Preconditions.checkNotNull;
import com.google.guava4pingcap.base.Objects;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import javax.annotation.concurrent.Immutable;
/**
* A group of {@link ResolvedServerInfo}s that is returned from a {@link NameResolver}.
*
* @deprecated This class will be removed. Use {@link EquivalentAddressGroup} instead.
*/
@Deprecated
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
@Immutable
public final class ResolvedServerInfoGroup {
private final List resolvedServerInfoList;
private final Attributes attributes;
/**
* Constructs a new resolved server info group from {@link ResolvedServerInfo} list,
* with custom {@link Attributes} attached to it.
*
* @param resolvedServerInfoList list of resolved server info objects.
* @param attributes custom attributes for a given group.
*/
private ResolvedServerInfoGroup(List resolvedServerInfoList,
Attributes attributes) {
checkArgument(!resolvedServerInfoList.isEmpty(), "empty server list");
this.resolvedServerInfoList =
Collections.unmodifiableList(new ArrayList(resolvedServerInfoList));
this.attributes = checkNotNull(attributes, "attributes");
}
/**
* Returns immutable list of {@link ResolvedServerInfo} objects for this group.
*/
public List getResolvedServerInfoList() {
return resolvedServerInfoList;
}
/**
* Returns {@link Attributes} for this group.
*/
public Attributes getAttributes() {
return attributes;
}
/**
* Converts this group to {@link EquivalentAddressGroup} object.
*/
public EquivalentAddressGroup toEquivalentAddressGroup() {
List addrs = new ArrayList(resolvedServerInfoList.size());
for (ResolvedServerInfo resolvedServerInfo : resolvedServerInfoList) {
addrs.add(resolvedServerInfo.getAddress());
}
return new EquivalentAddressGroup(addrs, attributes);
}
/**
* Creates a new builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* Creates a new builder for a group with extra attributes.
*/
public static Builder builder(Attributes attributes) {
return new Builder(attributes);
}
/**
* Returns true if the given object is also a {@link ResolvedServerInfoGroup} with an equal
* attributes and list of {@link ResolvedServerInfo} objects.
*
* @param o an object.
* @return true if the given object is a {@link ResolvedServerInfoGroup} with an equal attributes
* and server info list.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ResolvedServerInfoGroup that = (ResolvedServerInfoGroup) o;
return Objects.equal(resolvedServerInfoList, that.resolvedServerInfoList)
&& Objects.equal(attributes, that.attributes);
}
/**
* Returns a hash code for the resolved server info group.
*
* Note that if a resolver includes mutable values in the attributes, this object's hash code
* could change over time. So care must be used when putting these objects into a set or using
* them as keys for a map.
*
* @return a hash code for the server info group.
*/
@Override
public int hashCode() {
return Objects.hashCode(resolvedServerInfoList, attributes);
}
@Override
public String toString() {
return "[servers=" + resolvedServerInfoList + ", attrs=" + attributes + "]";
}
/**
* Builder for a {@link ResolvedServerInfo}.
*/
@Deprecated
public static final class Builder {
private final List group = new ArrayList();
private final Attributes attributes;
public Builder(Attributes attributes) {
this.attributes = attributes;
}
public Builder() {
this(Attributes.EMPTY);
}
public Builder add(ResolvedServerInfo resolvedServerInfo) {
group.add(resolvedServerInfo);
return this;
}
public Builder addAll(Collection resolvedServerInfo) {
group.addAll(resolvedServerInfo);
return this;
}
public ResolvedServerInfoGroup build() {
return new ResolvedServerInfoGroup(group, attributes);
}
}
}