CommonPrefix.java

/*
 * Copyright 2018 Global Crop Diversity Trust
 *
 * 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 org.genesys.filerepository.service.s3;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;

/**
 * <p>
 * A response will contain CommonPrefixes only if you specify a delimiter. When
 * you do, CommonPrefixes contains all (if there are any) keys between Prefix
 * and the next occurrence of the string specified by delimiter. In effect,
 * CommonPrefixes lists keys that act like subdirectories in the directory
 * specified by Prefix.
 * </p>
 *
 * <p>
 * For example, if prefix is notes/ and delimiter is a slash (/), in
 * notes/summer/july, the common prefix is notes/summer/. All of the keys rolled
 * up in a common prefix count as a single return when calculating the number of
 * returns.
 * </p>
 *
 * <pre>
&lt;CommonPrefixes&gt;
    &lt;Prefix&gt;photos/&lt;/Prefix&gt;
&lt;/CommonPrefixes&gt;
 * </pre>
 */
@XmlAccessorType(XmlAccessType.NONE)
public class CommonPrefix {

	/** The prefix. */
	@XmlElement(name = "Prefix")
	private String prefix;

	/**
	 * Gets the prefix.
	 *
	 * @return the prefix
	 */
	public String getPrefix() {
		return prefix;
	}

	/**
	 * Sets the prefix.
	 *
	 * @param prefix the prefix to set
	 */
	public void setPrefix(final String prefix) {
		this.prefix = prefix;
	}
}