Top Description Fields Constructors Methods
com.rometools.rome.feed.synd

public Class SyndCategoryImpl

extends Object
implements Serializable, SyndCategory
Class Inheritance
All Implemented Interfaces
com.rometools.rome.feed.synd.SyndCategory, com.rometools.rome.feed.CopyFrom, java.lang.Cloneable, java.io.Serializable
Imports
java.io.Serializable, java.util.Collections, .HashMap, .Map, com.rometools.rome.feed.CopyFrom, com.rometools.rome.feed.impl.CloneableBean, .CopyFromHelper, .EqualsBean, .ToStringBean, com.rometools.rome.feed.module.DCSubject, .DCSubjectImpl
Bean for categories of SyndFeedImpl feeds and entries.

Field Summary

Modifier and TypeField and Description
private static final CopyFromHelper
COPY_FROM_HELPER

private String
label

private static final long
serialVersionUID

private final DCSubject
subject

Constructor Summary

AccessConstructor and Description
pack-priv
SyndCategoryImpl(final DCSubject
the DC subject to wrap.
subject)

For implementations extending SyndContentImpl to be able to use the ObjectBean functionality with extended interfaces.

public
SyndCategoryImpl()

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a clone of the object.
clone()

Overrides java.lang.Object.clone.

Implements com.rometools.rome.feed.synd.SyndCategory.clone.

Creates a deep 'bean' clone of the object.
public void
copyFrom(final CopyFrom
the instance to copy properties from.
obj)

Implements com.rometools.rome.feed.CopyFrom.copyFrom.

Copies all the properties of the given bean into this one.
public boolean

Returns:

true if 'this' object is equal to the 'other' object.
equals(final Object
he reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
public Class<? extends CopyFrom>
getInterface()

Implements com.rometools.rome.feed.CopyFrom.getInterface.

Returns the interface the copyFrom works on.
public String
getLabel()

Implements com.rometools.rome.feed.synd.SyndCategory.getLabel.

Returns the category label, null if none
public String

Returns:

the category name, null if none.
getName()

Implements com.rometools.rome.feed.synd.SyndCategory.getName.

Returns the category name.
pack-priv DCSubject

Returns:

the DC subject being wrapped.
getSubject()

Package private constructor, used by SyndCategoryListFacade.

public String

Returns:

the category taxonomy URI, null if none.
getTaxonomyUri()

Implements com.rometools.rome.feed.synd.SyndCategory.getTaxonomyUri.

Returns the category taxonomy URI.
public int

Returns:

the hashcode of the bean object.
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode value for the object.
public void
setLabel(final String
the category label to set, null if none
label)

Implements com.rometools.rome.feed.synd.SyndCategory.setLabel.

Sets the category Label.
public void
setName(final String
the category name to set, null if none.
name)

Implements com.rometools.rome.feed.synd.SyndCategory.setName.

Sets the category name.
public void
setTaxonomyUri(final String
the category taxonomy URI to set, null if none.
taxonomyUri)

Implements com.rometools.rome.feed.synd.SyndCategory.setTaxonomyUri.

Sets the category taxonomy URI.
public String

Returns:

String representation for the object.
toString()

Overrides java.lang.Object.toString.

Returns the String representation for the object.
Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

COPY_FROM_HELPERback to summary
private static final CopyFromHelper COPY_FROM_HELPER
labelback to summary
private String label
serialVersionUIDback to summary
private static final long serialVersionUID
subjectback to summary
private final DCSubject subject

Constructor Detail

SyndCategoryImplback to summary
pack-priv SyndCategoryImpl(final DCSubject subject)

For implementations extending SyndContentImpl to be able to use the ObjectBean functionality with extended interfaces.

Parameters
subject:DCSubject

the DC subject to wrap.

SyndCategoryImplback to summary
public SyndCategoryImpl()

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Implements com.rometools.rome.feed.synd.SyndCategory.clone.

Creates a deep 'bean' clone of the object.

Returns:Object

a clone of the object.

Annotations
@Override
Exceptions
CloneNotSupportedException:
thrown if an element of the object cannot be cloned.
copyFromback to summary
public void copyFrom(final CopyFrom obj)

Implements com.rometools.rome.feed.CopyFrom.copyFrom.

Doc from com.rometools.rome.feed.CopyFrom.copyFrom.

Copies all the properties of the given bean into this one.

Any existing properties in this bean are lost.

This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation.

Parameters
obj:CopyFrom

the instance to copy properties from.

Annotations
@Override
equalsback to summary
public boolean equals(final Object other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one as defined by the Object equals() method.

Parameters
other:Object

he reference object with which to compare.

Returns:boolean

true if 'this' object is equal to the 'other' object.

Annotations
@Override
getInterfaceback to summary
public Class<? extends CopyFrom> getInterface()

Implements com.rometools.rome.feed.CopyFrom.getInterface.

Doc from com.rometools.rome.feed.CopyFrom.getInterface.

Returns the interface the copyFrom works on.

This is useful when dealing with properties that may have multiple implementations. For example, Module.

Returns:Class<? extends CopyFrom>

the interface the copyFrom works on.

Annotations
@Override
getLabelback to summary
public String getLabel()

Implements com.rometools.rome.feed.synd.SyndCategory.getLabel.

Doc from com.rometools.rome.feed.synd.SyndCategory.getLabel.

Returns the category label, null if none

Annotations
@Override
getNameback to summary
public String getName()

Implements com.rometools.rome.feed.synd.SyndCategory.getName.

Returns the category name.

Returns:String

the category name, null if none.

Annotations
@Override
getSubjectback to summary
pack-priv DCSubject getSubject()

Package private constructor, used by SyndCategoryListFacade.

Returns:DCSubject

the DC subject being wrapped.

getTaxonomyUriback to summary
public String getTaxonomyUri()

Implements com.rometools.rome.feed.synd.SyndCategory.getTaxonomyUri.

Returns the category taxonomy URI.

Returns:String

the category taxonomy URI, null if none.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode value for the object.

It follows the contract defined by the Object hashCode() method.

Returns:int

the hashcode of the bean object.

Annotations
@Override
setLabelback to summary
public void setLabel(final String label)

Implements com.rometools.rome.feed.synd.SyndCategory.setLabel.

Sets the category Label.

Parameters
label:String

the category label to set, null if none

Annotations
@Override
setNameback to summary
public void setName(final String name)

Implements com.rometools.rome.feed.synd.SyndCategory.setName.

Sets the category name.

Parameters
name:String

the category name to set, null if none.

Annotations
@Override
setTaxonomyUriback to summary
public void setTaxonomyUri(final String taxonomyUri)

Implements com.rometools.rome.feed.synd.SyndCategory.setTaxonomyUri.

Sets the category taxonomy URI.

Parameters
taxonomyUri:String

the category taxonomy URI to set, null if none.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns the String representation for the object.

Returns:String

String representation for the object.

Annotations
@Override