org.hibernate.sql.ordering.antlr.Node Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2008 Red Hat Inc. or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program 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 distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.sql.ordering.antlr;
/**
* General contract for AST nodes.
*
* @author Steve Ebersole
*/
public interface Node {
/**
* Get the intrinsic text of this node.
*
* @return The node's text.
*/
public String getText();
/**
* Get a string representation of this node usable for debug logging or similar.
*
* @return The node's debugging text.
*/
public String getDebugText();
/**
* Build the node's representation for use in the resulting rendering.
*
* @return The text for use in the translated output.
*/
public String getRenderableText();
}