com.rometools.rome.feed.synd

Class SyndCategoryListFacade

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<SyndCategory>

com.rometools.rome.feed.synd.SyndCategoryListFacade

All Implemented Interfaces:

java.lang.Iterable<SyndCategory>, java.util.Collection<SyndCategory>, java.util.List<SyndCategory>

class SyndCategoryListFacade
extends java.util.AbstractList<SyndCategory>

List implementation for SyndCategoryImpl elements. To be directly used by the SyndFeedImpl and SyndEntryImpl classes only.

It acts as a facade on top of the DCSubjectImpl elements of the underlying list and remains in synch with it. It is possible to work on either list, the categories one or the subjects one and they remain in synch.

This is necessary because the SyndFeedImpl categories are just a convenience to access the DublinCore subjects.

All this mess to avoid making DCSubjectImpl implement SyndCategory (which it would be odd).

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<DCSubject>	subjects

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SyndCategoryListFacade() Default constructor.
SyndCategoryListFacade(java.util.List<DCSubject> subjects) Creates a facade list of categories on top the given subject list.

Method Summary

Modifier and Type	Method and Description
void	add(int index, SyndCategory obj) Adds a category to the list.
static java.util.List<DCSubject>	convertElementsSyndCategoryToSubject(java.util.List<SyndCategory> cList) Returns a list with the DCSubject elements of the SyndCategoryImpl list facade.
SyndCategory	get(int index) Gets the category by index.
SyndCategory	remove(int index) Removes a category element from a specific position.
SyndCategory	set(int index, SyndCategory obj) Sets a category in an existing position in the list.
int	size() Returns the size of the list.

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

subjects

private final java.util.List<DCSubject> subjects

Constructor Detail

SyndCategoryListFacade

public SyndCategoryListFacade()

Default constructor. Creates and empty list.

SyndCategoryListFacade

public SyndCategoryListFacade(java.util.List<DCSubject> subjects)

Creates a facade list of categories on top the given subject list.

Parameters:

subjects - the list of subjects to create the facade.

Method Detail

get

public SyndCategory get(int index)

Gets the category by index.

Specified by:

get in interface java.util.List<SyndCategory>

Specified by:

get in class java.util.AbstractList<SyndCategory>

Parameters:

index - the index position to retrieve the category.

Returns:

the SyndCategoryImpl in position index, null if none.

size

public int size()

Returns the size of the list.

Specified by:

size in interface java.util.Collection<SyndCategory>

Specified by:

size in interface java.util.List<SyndCategory>

Specified by:

size in class java.util.AbstractCollection<SyndCategory>

Returns:

the size of the list.

set

public SyndCategory set(int index,
                        SyndCategory obj)

Sets a category in an existing position in the list.

Specified by:

set in interface java.util.List<SyndCategory>

Overrides:

set in class java.util.AbstractList<SyndCategory>

Parameters:

index - position to set the category.

obj - the SyndCategoryImpl object to set.

Returns:

the SyndCategoryImpl object that is being replaced, null if none.

add

public void add(int index,
                SyndCategory obj)

Adds a category to the list.

Specified by:

add in interface java.util.List<SyndCategory>

Overrides:

add in class java.util.AbstractList<SyndCategory>

Parameters:

index - position to add the category.

obj - the SyndCategoryImpl object to add.

remove

public SyndCategory remove(int index)

Removes a category element from a specific position.

Specified by:

remove in interface java.util.List<SyndCategory>

Overrides:

remove in class java.util.AbstractList<SyndCategory>

Parameters:

index - position to remove the category from.

Returns:

the SyndCategoryImpl being removed from position index, null if none.

convertElementsSyndCategoryToSubject

public static java.util.List<DCSubject> convertElementsSyndCategoryToSubject(java.util.List<SyndCategory> cList)

Returns a list with the DCSubject elements of the SyndCategoryImpl list facade. To be used by the SyndFeedImpl class only.

Parameters:

cList - the list with SyndCategoryImpl elements to convert to subject list.

Returns:

a list with DCSubject elements corresponding to the categories in the given list.