blob: 642be5742ae12c4b4b79c77cba397412ed66b839 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2006, 2013 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation
*
******************************************************************************/
package org.eclipse.persistence.tools.mapping;
import org.eclipse.persistence.tools.utility.TextRange;
/**
* This interface is the root interface that any external form should extends.
* <p>
* Provisional API: This interface is part of an interim API that is still under development and
* expected to change significantly before reaching stability. It is available at this early stage
* to solicit feedback from pioneering adopters on the understanding that any code that uses this
* API will almost certainly be broken (repeatedly) as the API evolves.<p>
*
* @version 2.6
*/
public interface ExternalForm {
/**
* Returns the {@link TextRange} for the entire element represented by this form.
*
* @return The {@link TextRange} of this form's element or <code>null</code> if the element does not exist
*/
TextRange getTextRange();
}