InspectNetworkParams.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.plugin.docker.client.params.network;

import javax.validation.constraints.NotNull;

import java.util.Objects;

import static java.util.Objects.requireNonNull;

/**
 * Arguments holder for {@link org.eclipse.che.plugin.docker.client.DockerConnector#inspectNetwork(InspectNetworkParams)}.
 *
 * @author Alexander Garagatyi
 */
public class InspectNetworkParams {
    private String netId;

    private InspectNetworkParams() {}

    /**
     * Creates arguments holder with required parameters.
     *
     * @param netId
     *         network identifier
     * @return arguments holder with required parameters
     * @throws NullPointerException
     *         if {@code netId} is null
     */
    public static InspectNetworkParams create(@NotNull String netId) {
        return new InspectNetworkParams().withNetworkId(netId);
    }

    /**
     * Adds network identifier to this parameters.
     *
     * @param netId
     *         network identifier
     * @return this params instance
     * @throws NullPointerException
     *         if {@code netId} is null
     */
    public InspectNetworkParams withNetworkId(@NotNull String netId) {
        requireNonNull(netId);
        this.netId = netId;
        return this;
    }

    public String getNetworkId() {
        return netId;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof InspectNetworkParams)) {
            return false;
        }
        final InspectNetworkParams that = (InspectNetworkParams)obj;
        return Objects.equals(netId, that.netId);
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 31 * hash + Objects.hashCode(netId);
        return hash;
    }

    @Override
    public String toString() {
        return "InspectNetworkParams{" +
               "netId='" + netId + '\'' +
               '}';
    }
}