com.aoindustries.website.framework.DescriptionAutoListPage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aoweb-framework Show documentation

Legacy servlet-based web framework, superfast and capable but tedious to use.

There is a newer version: 2.0.0

/*
 * aoweb-framework - Legacy servlet-based web framework, superfast and capable but tedious to use.
 * Copyright (C) 2005-2009, 2015, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoweb-framework.
 *
 * aoweb-framework 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.
 *
 * aoweb-framework 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 aoweb-framework.  If not, see .
 */
package com.aoindustries.website.framework;

import com.aoindustries.encoding.ChainWriter;
import java.io.IOException;
import java.sql.SQLException;
import javax.servlet.http.HttpServletResponse;

/**
 * Automatically generates the description along with a list of all pages.
 *
 * @author  AO Industries, Inc.
 */
abstract public class DescriptionAutoListPage extends AutoListPage {

	private static final long serialVersionUID = 1L;

	public DescriptionAutoListPage(LoggerAccessor loggerAccessor) {
		super(loggerAccessor);
	}

	public DescriptionAutoListPage(WebSiteRequest req) {
		super(req);
	}

	public DescriptionAutoListPage(LoggerAccessor loggerAccessor, Object param) {
		super(loggerAccessor, param);
	}

	/**
	 * Prints the content that will be put before the auto-generated list.
	 */
	@Override
	public void printContentStart(
		ChainWriter out,
		WebSiteRequest req,
		HttpServletResponse resp
	) throws IOException, SQLException {
		out.print(getDescription());
	}
}