org.restlet.resource.Variant Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.restlet
Show all versions of org.apache.servicemix.bundles.restlet
This OSGi bundle wraps org.restlet, and com.noelios.restlet ${pkgVersion} jar files.
The newest version!
/**
* Copyright 2005-2008 Noelios Technologies.
*
* The contents of this file are subject to the terms of the following open
* source licenses: LGPL 3.0 or LGPL 2.1 or CDDL 1.0 (the "Licenses"). You can
* select the license that you prefer but you may not use this file except in
* compliance with one of these Licenses.
*
* You can obtain a copy of the LGPL 3.0 license at
* http://www.gnu.org/licenses/lgpl-3.0.html
*
* You can obtain a copy of the LGPL 2.1 license at
* http://www.gnu.org/licenses/lgpl-2.1.html
*
* You can obtain a copy of the CDDL 1.0 license at
* http://www.sun.com/cddl/cddl.html
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royaltee free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://www.noelios.com/products/restlet-engine
*
* Restlet is a registered trademark of Noelios Technologies.
*/
package org.restlet.resource;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import org.restlet.data.CharacterSet;
import org.restlet.data.Encoding;
import org.restlet.data.Language;
import org.restlet.data.MediaType;
import org.restlet.data.Reference;
import org.restlet.data.Tag;
import org.restlet.util.DateUtils;
import org.restlet.util.WrapperList;
/**
* Descriptor for available representations of a resource. It contains all the
* important metadata about a representation but is not able to actually serve
* the representation's content itself.
*
* For this, you need to use the Representation subclass.
*
* @author Jerome Louvel
*/
public class Variant {
/**
* Indicates that the size of the representation can't be known in advance.
*
* @deprecated Use the {@link Representation#UNKNOWN_SIZE} constant instead.
*/
@Deprecated
public static final long UNKNOWN_SIZE = -1L;
/** The character set or null if not applicable. */
private volatile CharacterSet characterSet;
/** The additional content codings applied to the entity-body. */
private volatile List encodings;
/** The expiration date. */
private volatile Date expirationDate;
/**
* The identifier.
*/
private volatile Reference identifier;
/** The natural language(s) of the intended audience for this variant. */
private volatile List languages;
/** The media type. */
private volatile MediaType mediaType;
/** The modification date. */
private volatile Date modificationDate;
/**
* The expected size. Dynamic representations can have any size, but
* sometimes we can know in advance the expected size. If this expected size
* is specified by the user, it has a higher priority than any size that can
* be guessed by the representation (like a file size).
*/
private volatile long size;
/** The tag. */
private volatile Tag tag;
/**
* Default constructor.
*/
public Variant() {
this(null);
}
/**
* Constructor.
*
* @param mediaType
* The media type.
*/
public Variant(MediaType mediaType) {
this.characterSet = null;
this.encodings = null;
this.size = UNKNOWN_SIZE;
this.expirationDate = null;
this.languages = null;
this.mediaType = mediaType;
this.modificationDate = null;
this.tag = null;
this.identifier = null;
}
/**
* Returns the character set or null if not applicable.
*
* @return The character set or null if not applicable.
*/
public CharacterSet getCharacterSet() {
return this.characterSet;
}
/**
* Returns the modifiable list of encodings applied to the entity-body.
* Creates a new instance if no one has been set. An
* "IllegalArgumentException" exception is thrown when adding a null
* encoding to this list.
*
* @return The list of encodings applied to the entity-body.
*/
public List getEncodings() {
if (this.encodings == null) {
this.encodings = new WrapperList() {
@Override
public boolean add(Encoding element) {
if (element == null) {
throw new IllegalArgumentException(
"Cannot add a null encoding.");
}
return super.add(element);
}
@Override
public void add(int index, Encoding element) {
if (element == null) {
throw new IllegalArgumentException(
"Cannot add a null encoding.");
}
super.add(index, element);
}
@Override
public boolean addAll(Collection elements) {
boolean addNull = (elements == null);
if (!addNull) {
for (final Iterator iterator = elements
.iterator(); !addNull && iterator.hasNext();) {
addNull = (iterator.next() == null);
}
}
if (addNull) {
throw new IllegalArgumentException(
"Cannot add a null encoding.");
}
return super.addAll(elements);
}
@Override
public boolean addAll(int index,
Collection elements) {
boolean addNull = (elements == null);
if (!addNull) {
for (final Iterator iterator = elements
.iterator(); !addNull && iterator.hasNext();) {
addNull = (iterator.next() == null);
}
}
if (addNull) {
throw new IllegalArgumentException(
"Cannot add a null encoding.");
}
return super.addAll(index, elements);
}
};
}
return this.encodings;
}
/**
* Returns the future date when this representation expire. If this
* information is not known, returns null.
*
* @return The expiration date.
* @deprecated Use the {@link Representation#getExpirationDate()} method
* instead.
*/
@Deprecated
public Date getExpirationDate() {
return this.expirationDate;
}
/**
* Returns an optional identifier. This is useful when the representation is
* accessible from a location separate from the representation's resource
* URI, for example when content negotiation occurs.
*
* @return The identifier.
*/
public Reference getIdentifier() {
return this.identifier;
}
/**
* Returns the modifiable list of languages. Creates a new instance if no
* one has been set. An "IllegalArgumentException" exception is thrown when
* adding a null language to this list.
*
* @return The list of languages.
*/
public List getLanguages() {
if (this.languages == null) {
this.languages = new WrapperList() {
@Override
public void add(int index, Language element) {
if (element == null) {
throw new IllegalArgumentException(
"Cannot add a null language.");
}
super.add(index, element);
}
@Override
public boolean add(Language element) {
if (element == null) {
throw new IllegalArgumentException(
"Cannot add a null language.");
}
return super.add(element);
}
@Override
public boolean addAll(Collection elements) {
boolean addNull = (elements == null);
if (!addNull) {
for (final Iterator iterator = elements
.iterator(); !addNull && iterator.hasNext();) {
addNull = (iterator.next() == null);
}
}
if (addNull) {
throw new IllegalArgumentException(
"Cannot add a null language.");
}
return super.addAll(elements);
}
@Override
public boolean addAll(int index,
Collection elements) {
boolean addNull = (elements == null);
if (!addNull) {
for (final Iterator iterator = elements
.iterator(); !addNull && iterator.hasNext();) {
addNull = (iterator.next() == null);
}
}
if (addNull) {
throw new IllegalArgumentException(
"Cannot add a null language.");
}
return super.addAll(index, elements);
}
};
}
return this.languages;
}
/**
* Returns the media type.
*
* @return The media type.
*/
public MediaType getMediaType() {
return this.mediaType;
}
/**
* Returns the last date when this representation was modified. If this
* information is not known, returns null.
*
* @return The modification date.
* @deprecated Use the {@link Representation#getModificationDate()} method
* instead.
*/
@Deprecated
public Date getModificationDate() {
return this.modificationDate;
}
/**
* Returns the size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
*
* @return The size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
* @deprecated Use the {@link Representation#getSize()} method instead.
*/
@Deprecated
public long getSize() {
return this.size;
}
/**
* Returns the tag.
*
* @return The tag.
* @deprecated Use the {@link Representation#getTag()} method instead.
*/
@Deprecated
public Tag getTag() {
return this.tag;
}
/**
* Sets the character set or null if not applicable.
*
* @param characterSet
* The character set or null if not applicable.
*/
public void setCharacterSet(CharacterSet characterSet) {
this.characterSet = characterSet;
}
/**
* Sets the list of encodings applied to the entity-body.
*
* @param encodings
* The list of encodings applied to the entity-body.
*/
public void setEncodings(List encodings) {
this.encodings = encodings;
}
/**
* Sets the future date when this representation expire. If this information
* is not known, pass null.
*
* @param expirationDate
* The expiration date.
* @deprecated Use the {@link Representation#setExpirationDate(Date)} method
* instead.
*/
@Deprecated
public void setExpirationDate(Date expirationDate) {
this.expirationDate = DateUtils.unmodifiable(expirationDate);
}
/**
* Sets the optional identifier. This is useful when the representation is
* accessible from a location separate from the representation's resource
* URI, for example when content negotiation occurs.
*
* @param identifier
* The identifier.
*/
public void setIdentifier(Reference identifier) {
this.identifier = identifier;
}
/**
* Sets the identifier from a URI string.
*
* @param identifierUri
* The identifier to parse.
*/
public void setIdentifier(String identifierUri) {
setIdentifier(new Reference(identifierUri));
}
/**
* Sets the list of languages.
*
* @param languages
* The list of languages.
*/
public void setLanguages(List languages) {
this.languages = languages;
}
/**
* Sets the media type.
*
* @param mediaType
* The media type.
*/
public void setMediaType(MediaType mediaType) {
this.mediaType = mediaType;
}
/**
* Sets the last date when this representation was modified. If this
* information is not known, pass null.
*
* @param modificationDate
* The modification date.
* @deprecated Use the {@link Representation#setModificationDate(Date)}
* method instead.
*/
@Deprecated
public void setModificationDate(Date modificationDate) {
this.modificationDate = DateUtils.unmodifiable(modificationDate);
}
/**
* Sets the expected size in bytes if known, -1 otherwise.
*
* @param expectedSize
* The expected size in bytes if known, -1 otherwise.
* @deprecated Use the {@link Representation#setSize(long)} method instead.
*/
@Deprecated
public void setSize(long expectedSize) {
this.size = expectedSize;
}
/**
* Sets the tag.
*
* @param tag
* The tag.
* @deprecated Use the {@link Representation#setTag(Tag)} method instead.
*/
@Deprecated
public void setTag(Tag tag) {
this.tag = tag;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy