/*===========================================================================
Copyright (C) 2011 by the Okapi Framework contributors
-----------------------------------------------------------------------------
This library is free software; you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published by 
the Free Software Foundation; either version 2.1 of the License, or (at 
your option) any later version.

This library is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License 
along with this library; if not, write to the Free Software Foundation, 
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package org.oasisopen.xliff.v2;

import java.io.Serializable;

/**
 * Provides the method to store and manipulate markers (e.g. codes, annotations) in a given content.
 */
public interface IMarkers extends Serializable, Iterable<IMarker> {

	public int size ();

	public boolean hasCodeWithOriginalData ();
	
	/**
	 * Gets the data store associated with this list of markers.
	 * @return the data store associated with this object.
	 */
	public IDataStore getDataStore ();

	/**
	 * Gets the marker at a given position.
	 * @param index the index of the marker to retrieve (first one is at 0).
	 * @return the retrieved marker. 
	 */
	public IMarker get (int index);
	
	public IMarker get (String id,
		InlineType type);

	public void add (IMarker marker);

}
