All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.cloud.dataflow.sdk.coders.SetCoder Maven / Gradle / Ivy

Go to download

Google Cloud Dataflow Java SDK provides a simple, Java-based interface for processing virtually any size data using Google cloud resources. This artifact includes entire Dataflow Java SDK.

There is a newer version: 2.5.0
Show newest version
/*
 * Copyright (C) 2015 Google Inc.
 *
 * 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.dataflow.sdk.coders;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.cloud.dataflow.sdk.util.PropertyNames;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * A {@link SetCoder} encodes any {@link Set} using the format of {@link IterableLikeCoder}. The
 * elements may not be in a deterministic order, depending on the {@code Set} implementation.
 *
 * @param  the type of the elements of the set
 */
public class SetCoder extends IterableLikeCoder> {

  /**
   * Produces a {@link SetCoder} with the given {@code elementCoder}.
   */
  public static  SetCoder of(Coder elementCoder) {
    return new SetCoder<>(elementCoder);
  }

  /**
   * Dynamically typed constructor for JSON deserialization.
   */
  @JsonCreator
  public static SetCoder of(
      @JsonProperty(PropertyNames.COMPONENT_ENCODINGS)
      List components) {
    checkArgument(components.size() == 1, "Expecting 1 component, got " + components.size());
    return of((Coder) components.get(0));
  }

  /**
   * {@inheritDoc}
   *
   * @throws NonDeterministicException always. Sets are not ordered, but
   *         they are encoded in the order of an arbitrary iteration.
   */
  @Override
  public void verifyDeterministic() throws NonDeterministicException {
    throw new NonDeterministicException(this,
        "Ordering of elements in a set may be non-deterministic.");
  }

  /**
   * Returns the first element in this set if it is non-empty,
   * otherwise returns {@code null}.
   */
  public static  List getInstanceComponents(
      Set exampleValue) {
    return getInstanceComponentsHelper(exampleValue);
  }

  /////////////////////////////////////////////////////////////////////////////
  // Internal operations below here.

  /**
   * {@inheritDoc}
   *
   * @return A new {@link Set} built from the elements in the {@link List} decoded by
   * {@link IterableLikeCoder}.
   */
  @Override
  protected final Set decodeToIterable(List decodedElements) {
    return new HashSet<>(decodedElements);
  }

  protected SetCoder(Coder elemCoder) {
    super(elemCoder, "Set");
  }
}