com.biomatters.geneious.publicapi.plugin

Class SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<SequenceAnnotationGenerator.AnnotationGeneratorResult>

com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence

All Implemented Interfaces:

Iterable<SequenceAnnotationGenerator.AnnotationGeneratorResult>, Collection<SequenceAnnotationGenerator.AnnotationGeneratorResult>, List<SequenceAnnotationGenerator.AnnotationGeneratorResult>

Enclosing class:

SequenceAnnotationGenerator

public static class SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence
extends AbstractList<SequenceAnnotationGenerator.AnnotationGeneratorResult>

An implementation of a List of SequenceAnnotationGenerator.AnnotationGeneratorResult where all elements except one are empty results. This may be returned from SequenceAnnotationGenerator.generate(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange, jebl.util.ProgressListener, Options) to allow the calling code to quickly recognize that only a single result in the list needs to be considered.

Since:

API 4.40 (Geneious 5.4.0)

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence(int listSize, int resultIndex, SequenceAnnotationGenerator.AnnotationGeneratorResult annotationGeneratorResult)

Method Summary

Methods

Modifier and Type	Method and Description
SequenceAnnotationGenerator.AnnotationGeneratorResult	get(int index)
int	getResultIndex() returns the index of the only entry in this list which isn't an empty result
int	size()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, 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, retainAll, toArray, toArray

Constructor Detail

SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence

public SequenceAnnotationGenerator.AnnotationGeneratorResultsOnSingleSequence(int listSize,
                                                                      int resultIndex,
                                                                      SequenceAnnotationGenerator.AnnotationGeneratorResult annotationGeneratorResult)

Parameters:

listSize - the size of the list

resultIndex - the index of the element in the list to return annotationGeneratorResult for. All other indexes will return an empty result.

annotationGeneratorResult - the result to return for resultIndex

Method Detail

get

public SequenceAnnotationGenerator.AnnotationGeneratorResult get(int index)

Specified by:

get in interface List<SequenceAnnotationGenerator.AnnotationGeneratorResult>

Specified by:

get in class AbstractList<SequenceAnnotationGenerator.AnnotationGeneratorResult>

size

public int size()

Specified by:

size in interface Collection<SequenceAnnotationGenerator.AnnotationGeneratorResult>

Specified by:

size in interface List<SequenceAnnotationGenerator.AnnotationGeneratorResult>

Specified by:

size in class AbstractCollection<SequenceAnnotationGenerator.AnnotationGeneratorResult>

getResultIndex

public int getResultIndex()

returns the index of the only entry in this list which isn't an empty result

Returns:

the index of the only entry in this list which isn't an empty result