• Home
• com.google.cloud
• google-cloud-datastore
• 2.21.2
• source code
• ListValue.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.datastore.ListValue Maven / Gradle / Ivy

/*
 * Copyright 2015 Google LLC
 *
 * 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.datastore;

import static com.google.datastore.v1.Value.ARRAY_VALUE_FIELD_NUMBER;

import com.google.cloud.Timestamp;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import java.util.ArrayList;
import java.util.List;

/** A Google Cloud Datastore list value. A list value is a list of {@link Value} objects. */
public final class ListValue extends Value>> {

  private static final long serialVersionUID = -5121887228607148857L;

  static final BaseMarshaller>, ListValue, Builder> MARSHALLER =
      new BaseMarshaller>, ListValue, Builder>() {

        private static final long serialVersionUID = 7720473855548179942L;

        @Override
        public int getProtoFieldId() {
          return ARRAY_VALUE_FIELD_NUMBER;
        }

        @Override
        public Builder newBuilder(List> values) {
          return ListValue.newBuilder().set(values);
        }

        @Override
        protected List> getValue(com.google.datastore.v1.Value from) {
          List> properties = new ArrayList<>(from.getArrayValue().getValuesCount());
          for (com.google.datastore.v1.Value valuePb : from.getArrayValue().getValuesList()) {
            properties.add(Value.fromPb(valuePb));
          }
          return properties;
        }

        @Override
        protected void setValue(ListValue from, com.google.datastore.v1.Value.Builder to) {
          List propertiesPb = new ArrayList<>();
          for (Value property : from.get()) {
            propertiesPb.add(property.toPb());
          }
          to.setArrayValue(
              com.google.datastore.v1.ArrayValue.newBuilder().addAllValues(propertiesPb));
        }
      };

  public static final class Builder
      extends Value.BaseBuilder>, ListValue, Builder> {

    private ImmutableList.Builder> listBuilder = ImmutableList.builder();

    private Builder() {
      super(ValueType.LIST);
    }

    private void addValueHelper(Value value) {
      // see datastore.proto definition for list_value
      Preconditions.checkArgument(value.getType() != ValueType.LIST, "Cannot contain another list");
      listBuilder.add(value);
    }

    /** Adds the provided values to the {@code ListValue} builder. */
    public Builder addValue(Value first, Value... other) {
      addValueHelper(first);
      for (Value value : other) {
        addValueHelper(value);
      }
      return this;
    }

    /** Adds the provided string values to the {@code ListValue} builder. */
    public Builder addValue(String first, String... other) {
      listBuilder.add(StringValue.of(first));
      for (String value : other) {
        listBuilder.add(StringValue.of(value));
      }
      return this;
    }

    /** Adds the provided long values to the {@code ListValue} builder. */
    public Builder addValue(long first, long... other) {
      listBuilder.add(LongValue.of(first));
      for (long value : other) {
        listBuilder.add(LongValue.of(value));
      }
      return this;
    }

    /** Adds the provided double values to the {@code ListValue} builder. */
    public Builder addValue(double first, double... other) {
      listBuilder.add(DoubleValue.of(first));
      for (double value : other) {
        listBuilder.add(DoubleValue.of(value));
      }
      return this;
    }

    /** Adds the provided boolean values to the {@code ListValue} builder. */
    public Builder addValue(boolean first, boolean... other) {
      listBuilder.add(BooleanValue.of(first));
      for (boolean value : other) {
        listBuilder.add(BooleanValue.of(value));
      }
      return this;
    }

    /** Adds the provided {@code Timestamp} values to the {@code ListValue} builder. */
    public Builder addValue(Timestamp first, Timestamp... other) {
      listBuilder.add(TimestampValue.of(first));
      for (Timestamp value : other) {
        listBuilder.add(TimestampValue.of(value));
      }
      return this;
    }

    /** Adds the provided {@code LatLng} values to the {@code ListValue} builder. */
    public Builder addValue(LatLng first, LatLng... other) {
      listBuilder.add(LatLngValue.of(first));
      for (LatLng value : other) {
        listBuilder.add(LatLngValue.of(value));
      }
      return this;
    }

    /** Adds the provided {@code Key} values to the {@code ListValue} builder. */
    public Builder addValue(Key first, Key... other) {
      listBuilder.add(KeyValue.of(first));
      for (Key value : other) {
        listBuilder.add(KeyValue.of(value));
      }
      return this;
    }

    /** Adds the provided {@code FullEntity} values to the {@code ListValue} builder. */
    public Builder addValue(FullEntity first, FullEntity... other) {
      listBuilder.add(EntityValue.of(first));
      for (FullEntity value : other) {
        listBuilder.add(EntityValue.of(value));
      }
      return this;
    }

    /** Adds the provided {@code Blob} values to the {@code ListValue} builder. */
    public Builder addValue(Blob first, Blob... other) {
      listBuilder.add(BlobValue.of(first));
      for (Blob value : other) {
        listBuilder.add(BlobValue.of(value));
      }
      return this;
    }

    /**
     * Sets the list of values of this {@code ListValue} builder to {@code values}. The provided
     * list is copied.
     *
     * @see com.google.cloud.datastore.Value.BaseBuilder#set(java.lang.Object)
     */
    @Override
    public Builder set(List> values) {
      listBuilder = ImmutableList.builder();
      for (Value value : values) {
        addValue(value);
      }
      return this;
    }

    @Override
    public List> get() {
      return listBuilder.build();
    }

    /** Creates a {@code ListValue} object. */
    @Override
    public ListValue build() {
      return new ListValue(this);
    }
  }

  public ListValue(List> values) {
    this(newBuilder().set(values));
  }

  public ListValue(Value first, Value... other) {
    this(new Builder().addValue(first, other));
  }

  private ListValue(Builder builder) {
    super(builder);
  }

  /** Returns a builder for the list value object. */
  @Override
  public Builder toBuilder() {
    return new Builder().mergeFrom(this);
  }

  /** Creates a {@code ListValue} object given a list of {@code Value} objects. */
  public static ListValue of(List> values) {
    return new ListValue(values);
  }

  /** Creates a {@code ListValue} object given a number of {@code Value} objects. */
  public static ListValue of(Value first, Value... other) {
    return new ListValue(first, other);
  }

  /** Creates a {@code ListValue} object given a number of string values. */
  public static ListValue of(String first, String... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of long values. */
  public static ListValue of(long first, long... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of double values. */
  public static ListValue of(double first, double... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of boolean values. */
  public static ListValue of(boolean first, boolean... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of {@code Timestamp} values. */
  public static ListValue of(Timestamp first, Timestamp... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of {@code LatLng} values. */
  public static ListValue of(LatLng first, LatLng... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of {@code Key} values. */
  public static ListValue of(Key first, Key... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of {@code FullEntity} values. */
  public static ListValue of(FullEntity first, FullEntity... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Creates a {@code ListValue} object given a number of {@code Blob} values. */
  public static ListValue of(Blob first, Blob... other) {
    return newBuilder().addValue(first, other).build();
  }

  /** Returns a builder for {@code ListValue} objects. */
  public static Builder newBuilder() {
    return new Builder();
  }
}