com.joyent.manta.client.multipart.MantaMultipartUploadTuple.java Source code

Introduction

Here is the source code for com.joyent.manta.client.multipart.MantaMultipartUploadTuple.java

Source

/*
 * Copyright (c) 2016-2017, Joyent, Inc. All rights reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package com.joyent.manta.client.multipart;

import org.apache.commons.lang3.builder.ToStringBuilder;

import java.io.Serializable;
import java.util.Objects;

/**
 * Minimal class representing the logical pairing of a ETag value and a
 * part number for a multipart upload part. This minimum set of identifying
 * values is needed when completing a Manta multipart upload.
 *
 * @author <a href="https://github.com/dekobon">Elijah Zupancic</a>
 * @since 2.5.0
 */
public class MantaMultipartUploadTuple implements Serializable, Comparable<MantaMultipartUploadTuple> {
    private static final long serialVersionUID = -4050887694675747077L;

    /**
     * Non-zero positive integer representing the relative position of the
     * part in relation to the other parts for the multipart upload.
     */
    private final int partNumber;

    /**
     * HTTP Etag value returned by Manta for the multipart upload part.
     */
    private final String etag;

    /**
     * Creates a new instance based on the passed parameters.
     *
     * @param partNumber Non-zero positive integer representing the relative
     *                   position of the part in relation to the other parts for the multipart upload.
     * @param etag HTTP Etag value returned by Manta for the multipart upload part
     */
    public MantaMultipartUploadTuple(final int partNumber, final Object etag) {
        this(partNumber, Objects.toString(etag));
    }

    /**
     * Creates a new instance based on the passed parameters.
     *
     * @param partNumber Non-zero positive integer representing the relative
     *                   position of the part in relation to the other parts for the multipart upload.
     * @param etag HTTP Etag value returned by Manta for the multipart upload part
     */
    public MantaMultipartUploadTuple(final int partNumber, final String etag) {
        this.partNumber = partNumber;
        this.etag = etag;
    }

    /**
     * @return An positive non-zero integer part number identifying the part's order
     */
    public int getPartNumber() {
        return this.partNumber;
    }

    /**
     * @return HTTP Etag value returned by Manta for the multipart upload part
     */
    public String getEtag() {
        return this.etag;
    }

    @Override
    public int compareTo(final MantaMultipartUploadTuple that) {
        return Integer.compare(this.getPartNumber(), that.getPartNumber());
    }

    @Override
    public boolean equals(final Object that) {
        if (this == that) {
            return true;
        }

        if (that == null || getClass() != that.getClass()) {
            return false;
        }

        MantaMultipartUploadTuple tuple = (MantaMultipartUploadTuple) that;
        return partNumber == tuple.partNumber && Objects.equals(etag, tuple.etag);
    }

    @Override
    public int hashCode() {
        return Objects.hash(partNumber, etag);
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this).append("partNumber", partNumber).append("etag", etag).toString();
    }
}