com.spotify.apollo.Payloads Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apollo-api Show documentation
There is a newer version: 1.20.4
/*
 * -\-\-
 * Spotify Apollo API Interfaces
 * --
 * Copyright (C) 2013 - 2015 Spotify AB
 * --
 * 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.spotify.apollo;

import com.spotify.apollo.route.Middleware;

import java.util.Objects;
import java.util.Optional;

import okio.ByteString;

import static com.spotify.apollo.Serializer.Payload;

/**
 * Factory for creating {@link Payload}
 *
 * @deprecated the new preferred way to do response serialization is
 * via a {@link Middleware}, see {@link Serializer}.
 */
@Deprecated
public final class Payloads {

  private Payloads() {
    // no instantiation
  }

  /**
   * Create a {@link Payload} from ByteString without contentType
   */
  public static Payload create(ByteString byteString) {
    return new PayloadImpl(byteString, Optional.empty());
  }

  /**
   * Create a {@link Payload} from ByteString with the
   * specified contentType
   */
  public static Payload create(ByteString byteString, String contentType) {
    return new PayloadImpl(byteString, Optional.ofNullable(contentType));
  }


  /**
   * Create a {@link Payload} from ByteString with an
   * optional contentType
   */
  public static Payload create(ByteString byteString, Optional contentType) {
    return new PayloadImpl(byteString, contentType);
  }

  static class PayloadImpl implements Payload {

    private final ByteString byteString;
    private final Optional contentType;

    private PayloadImpl(ByteString byteString, Optional contentType) {
      this.byteString = Objects.requireNonNull(byteString);
      this.contentType = Objects.requireNonNull(contentType);
    }

    @Override
    public ByteString byteString() {
      return byteString;
    }

    @Override
    public Optional contentType() {
      return contentType;
    }

    @Override
    public Payload withContentTypeIfAbsent(String contentType) {
      return create(byteString, this.contentType.orElse(contentType));
    }
  }
}