com.aspose.slides

Class CommentAuthorCollection

java.lang.Object

com.aspose.slides.DomObject<Presentation>

com.aspose.slides.CommentAuthorCollection

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICommentAuthor>, com.aspose.ms.System.Collections.ICollection<ICommentAuthor>, com.aspose.ms.System.Collections.IEnumerable<ICommentAuthor>, ICommentAuthorCollection, IGenericCollection<ICommentAuthor>, java.lang.Iterable<ICommentAuthor>

public final class CommentAuthorCollection
extends DomObject<Presentation>
implements ICommentAuthorCollection

Represents a collection of comment authors.

Method Summary

Modifier and Type	Method and Description
ICommentAuthor	addAuthor(java.lang.String name, java.lang.String initials) Add new author at the end of a collection.
void	clear() Removes all authors from a collection.
void	copyTo(com.aspose.ms.System.Array array, int index) Copies all elements from the collection to the specified array.
ICommentAuthor[]	findByName(java.lang.String name) Find author in a collection by name.
ICommentAuthor[]	findByNameAndInitials(java.lang.String name, java.lang.String initials) Find author in a collection by name and initials.
ICommentAuthor	get_Item(int index) Gets the element at the specified index.
java.lang.Object	getSyncRoot() Returns a synchronization root.
boolean	isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICommentAuthor>	iterator() Returns an enumerator that iterates through the collection.
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICommentAuthor>	iteratorJava() Returns a java iterator for the entire collection.
void	remove(ICommentAuthor author) Removes the first occurrence of the specified author in a collection.
void	removeAt(int index) Removes the author at the specified index of the collection.
int	size() Gets the number of elements actually contained in the collection.
ICommentAuthor[]	toArray() Creates and returns an array with all authors.

Methods inherited from class com.aspose.slides.DomObject

getParent_Immediate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

public final int size()

Gets the number of elements actually contained in the collection. Read-only int.

Specified by:

size in interface com.aspose.ms.System.Collections.ICollection<ICommentAuthor>

get_Item

public final ICommentAuthor get_Item(int index)

Gets the element at the specified index. Read-only ICommentAuthor.

Specified by:

get_Item in interface ICommentAuthorCollection

addAuthor

public final ICommentAuthor addAuthor(java.lang.String name,
                                      java.lang.String initials)

Add new author at the end of a collection.

Specified by:

addAuthor in interface ICommentAuthorCollection

Parameters:

name - Name of a new author.

initials - Initials of a new author.

Returns:

New ICommentAuthor object.

Throws:

PptxEditException - Thrown if author with the same name and initials is already added.

toArray

public final ICommentAuthor[] toArray()

Creates and returns an array with all authors.

Specified by:

toArray in interface ICommentAuthorCollection

Returns:

Array of ICommentAuthor

findByName

public final ICommentAuthor[] findByName(java.lang.String name)

Find author in a collection by name.

Specified by:

findByName in interface ICommentAuthorCollection

Parameters:

name - Name of an author to find.

Returns:

Author or null.

findByNameAndInitials

public final ICommentAuthor[] findByNameAndInitials(java.lang.String name,
                                                    java.lang.String initials)

Find author in a collection by name and initials.

Specified by:

findByNameAndInitials in interface ICommentAuthorCollection

Parameters:

name - Name of an author to find.

initials - Initials of an author to find.

Returns:

Author or null.

removeAt

public final void removeAt(int index)

Removes the author at the specified index of the collection.

Specified by:

removeAt in interface ICommentAuthorCollection

Parameters:

index - The zero-based index of the element to remove.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - Index is less than 0 or index is equal or greater than Count

PptxEditException - Thrown if author is already removed.

remove

public final void remove(ICommentAuthor author)

Removes the first occurrence of the specified author in a collection.

Specified by:

remove in interface ICommentAuthorCollection

Parameters:

author - The author to remove from a collection.

Throws:

com.aspose.ms.System.ArgumentNullException - Author is null

PptxEditException - Thrown if author is already removed.

clear

public final void clear()

Removes all authors from a collection.

Specified by:

clear in interface ICommentAuthorCollection

iterator

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICommentAuthor> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICommentAuthor>

Specified by:

iterator in interface com.aspose.ms.System.Collections.IEnumerable<ICommentAuthor>

Specified by:

iterator in interface java.lang.Iterable<ICommentAuthor>

Returns:

A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava

public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<ICommentAuthor> iteratorJava()

Returns a java iterator for the entire collection.

Specified by:

iteratorJava in interface IGenericCollection<ICommentAuthor>

Returns:

An Iterator for the entire collection.

copyTo

public final void copyTo(com.aspose.ms.System.Array array,
                         int index)

Copies all elements from the collection to the specified array.

Specified by:

copyTo in interface com.aspose.ms.System.Collections.ICollection<ICommentAuthor>

Parameters:

array - Target array.

index - Starting index in the target array.

isSynchronized

public final boolean isSynchronized()

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only boolean.

Specified by:

isSynchronized in interface com.aspose.ms.System.Collections.ICollection<ICommentAuthor>

getSyncRoot

public final java.lang.Object getSyncRoot()

Returns a synchronization root. Read-only Object.

Specified by:

getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<ICommentAuthor>