io.r2dbc.postgresql.message.backend.FunctionCallResponse Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * 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
 *
 *      https://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.r2dbc.postgresql.message.backend;

import io.netty.buffer.ByteBuf;
import io.r2dbc.postgresql.util.Assert;
import io.r2dbc.postgresql.util.ByteBufferUtils;
import reactor.util.annotation.Nullable;

import java.nio.ByteBuffer;
import java.util.Objects;

/**
 * The FunctionCallResponse message.
 */
public final class FunctionCallResponse implements BackendMessage {

    private static final int NULL = -1;

    private final ByteBuffer value;

    /**
     * Creates a new message.
     *
     * @param value the value of the function result, in the format indicated by the associated format code.
     */
    public FunctionCallResponse(@Nullable ByteBuf value) {
        this.value = value == null ? null : ByteBufferUtils.toByteBuffer(value);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        FunctionCallResponse that = (FunctionCallResponse) o;
        return Objects.equals(this.value, that.value);
    }

    /**
     * Returns the value of the function result, in the format indicated by the associated format code.
     *
     * @return the value of the function result, in the format indicated by the associated format code
     */
    public ByteBuffer getValue() {
        return this.value;
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.value);
    }

    @Override
    public String toString() {
        return "FunctionCallResponse{" +
            "value=" + this.value +
            '}';
    }

    static FunctionCallResponse decode(ByteBuf in) {
        Assert.requireNonNull(in, "in must not be null");

        int length = in.readInt();
        ByteBuf value = NULL == length ? null : in.readSlice(length);

        return new FunctionCallResponse(value);
    }

}