net.sf.nervalreports.generators.TeXEndBlockInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tex-generator Show documentation

This is the TeX generator package of NervalReports (a lightweight report creation library), used to generate a report in a LaTeX file (.tex).

There is a newer version: 1.2

Show newest version

/** This file is part of nervalreports.
 *
 * nervalreports 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 3 of the License, or
 * (at your option) any later version.
 *
 * nervalreports 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 nervalreports.  If not, see . */
package net.sf.nervalreports.generators;

/** Information about an opened block to end in LaTeX.
 * @author farrer */
/* default */ class TeXEndBlockInfo {

	/** If the block should explicitly end */
	private final boolean shouldEnd;
	/** When {@link #shouldEnd}, the string to use. */
	private final String endString;
	
	/** Default constructor.
	 * @param shouldEnd {@link #shouldEnd}
	 * @param endString {@link #endString} */
	TeXEndBlockInfo(boolean shouldEnd, String endString) {
		this.shouldEnd = shouldEnd;
		this.endString = endString;
	}

	/** @return {@link #shouldEnd}. */
	public boolean shouldExplicitlyEnd() {
		return shouldEnd;
	}

	/** @return {@link #endString}. */
	public String getEndString() {
		return endString;
	}
	
}