com.facebook.drift.codec.internal.builtin.VoidThriftCodec Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012 Facebook, 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.facebook.drift.codec.internal.builtin;

import com.facebook.drift.codec.ThriftCodec;
import com.facebook.drift.codec.metadata.ThriftType;
import com.facebook.drift.protocol.TProtocolReader;
import com.facebook.drift.protocol.TProtocolWriter;

import javax.annotation.concurrent.Immutable;

import static java.util.Objects.requireNonNull;

/**
 * VoidThriftCodec is a convenience codec used for service invocations that return void type.
 */
@Immutable
public class VoidThriftCodec
        implements ThriftCodec
{
    @Override
    public ThriftType getType()
    {
        return ThriftType.VOID;
    }

    /**
     * Always returns null without reading anything from the stream.
     */
    @Override
    public Void read(TProtocolReader protocol)
    {
        requireNonNull(protocol, "protocol is null");
        return null;
    }

    /**
     * Always returns without writing to the stream.
     */
    @Override
    public void write(Void value, TProtocolWriter protocol)
    {
        requireNonNull(protocol, "protocol is null");
    }
}