/*license*\
XBN-Java: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)
This software is dual-licensed under the:
- Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
- Apache Software License (ASL) version 2.0.
Either license may be applied at your discretion. More information may be found at
- http://en.wikipedia.org/wiki/Multi-licensing.
The text of both licenses is available in the root directory of this project, under the names "LICENSE_lgpl-3.0.txt" and "LICENSE_asl-2.0.txt". The latest copies may be downloaded at:
- LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
- ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
\*license*/
package com.github.xbn.linefilter.entity;
import com.github.xbn.linefilter.entity.raw.RawChildEntity;
/**
<p>A textual entity that may exist in a parent entity.</p>
* @since 0.1.0
* @author Copyright (C) 2014, Jeff Epstein ({@code aliteralmind __DASH__ github __AT__ yahoo __DOT__ com}), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <a href="http://xbnjava.aliteralmind.com">{@code http://xbnjava.aliteralmind.com}</a>, <a href="https://github.com/aliteralmind/xbnjava">{@code https://github.com/aliteralmind/xbnjava}</a>
**/
public interface TextChildEntity extends RawChildEntity<String> {
/**
<p>The entity this is contained in.</p>
* @return <ul>
<li>If this is the {@link #getTopParent() root parent} entity: {@code null},</li>
<li>Otherwise, a non-null parent entity which may or may not be the root.</li>
</ul>
* @see RawChildEntity#getParent()
*/
TextParentEntity getParent();
/**
<p>The root entity this is contained in.</p>
* @return <ul>
<li>If this is the root parent entity: {@code null}</li>
<li>Otherwise, a non-null parent entity whose parent is {@code null}.</li>
</ul>
* @see #getParent()
* @see RawChildEntity#getTopParent()
*/
TextParentEntity getTopParent();
}