net.java.dev.webdav.jaxrs.xml.elements.PropStat Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * WebDAV Support for JAX-RS
 * %%
 * Copyright (C) 2008 - 2014 The java.net WebDAV Project
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

package net.java.dev.webdav.jaxrs.xml.elements;

import static java.util.Objects.hash;
import static net.java.dev.webdav.util.Utilities.array;
import static net.java.dev.webdav.util.Utilities.notNull;

import java.util.Arrays;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import net.java.dev.webdav.util.Utilities;

/**
 * WebDAV propstat XML Element.
 * 
 * @author Markus KARG ([email protected])
 * 
 * @see Chapter 14.22 "propstat XML Element" of RFC 4918
 *      "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"
 */
@XmlType(propOrder = { "prop", "status", "error", "responseDescription" })
@XmlRootElement(name = "propstat")
public final class PropStat {

	@XmlElement
	private final Prop prop;

	@XmlElement
	private final Status status;

	@XmlElement
	private final Error error;

	@XmlElement(name = "responsedescription")
	private final ResponseDescription responseDescription;

	@SuppressWarnings("unused")
	private PropStat() {
		this.prop = null;
		this.status = null;
		this.error = null;
		this.responseDescription = null;
	}

	public PropStat(final Prop prop, final Status status, final Error error, final ResponseDescription responseDescription) {
		this.prop = notNull(prop, "prop");
		this.status = notNull(status, "status");
		this.error = error;
		this.responseDescription = responseDescription;
	}

	public PropStat(final Prop prop, final Status status) {
		this(prop, status, null, null);
	}

	public PropStat(final Prop prop, final Status status, final Error error) {
		this(prop, status, error, null);
	}

	public PropStat(final Prop prop, final Status status, final ResponseDescription responseDescription) {
		this(prop, status, null, responseDescription);
	}

	public final Prop getProp() {
		return this.prop;
	}

	public final Status getStatus() {
		return this.status;
	}

	public final Error getError() {
		return this.error;
	}

	public final ResponseDescription getResponseDescription() {
		return this.responseDescription;
	}

	@Override
	public final int hashCode() {
		return hash(this.prop, this.status, this.error, this.responseDescription);
	}

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

		if (!(this instanceof PropStat))
			return false;

		final PropStat that = (PropStat) o;

		return Arrays.equals(array(this.prop, this.status, this.error, this.responseDescription),
				array(that.prop, that.status, that.error, that.responseDescription));
	}

	@Override
	public final String toString() {
		return Utilities.toString(this, this.prop, this.status, this.error, this.responseDescription);
	}
}