| career | drupal | java | mac | mysql | perl | scala | uml | unix  

Ant example source code file (

This example Ant source code file ( is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Ant tags/keywords

buildexception, buildexception, file, file, io, java, skindirectory, string, string, stylebook, stylebook, targetdirectory

The source code

 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.


 * Executes the Apache Stylebook documentation generator.
 * Unlike the commandline version of this tool, all three arguments
 * are required to run stylebook.
 * <p>
 * Being extended from <Java>, all the parent's attributes
 * and options are available. Do not set any apart from the <tt>classpath
 * as they are not guaranteed to be there in future.
 * @todo stop extending from Java.
 * @deprecated since 1.7.
 *             This task is considered unsupported by the Ant developers
public class StyleBook extends Java {
    // CheckStyle:VisibilityModifier OFF - bc
    // CheckStyle:MemberNameCheck OFF - bc
    protected File m_targetDirectory;
    protected File m_skinDirectory;
    protected String m_loaderConfig;
    protected File m_book;
    // CheckStyle:MemberNameCheck ON
    // CheckStyle:VisibilityModifier ON

     * Constructor
    public StyleBook() {

     * Set the book xml file that the documentation generation starts from;
     * required.
     * @param book the source file

    public void setBook(final File book) {
        m_book = book;

     * Set the directory that contains the stylebook skin;
     * required.
     * @param skinDirectory the location of the stylebook skin
    public void setSkinDirectory(final File skinDirectory) {
        m_skinDirectory = skinDirectory;

     * Set the destination directory where the documentation is generated;
     * required.
     * @param targetDirectory the document output directory
    public void setTargetDirectory(final File targetDirectory) {
        m_targetDirectory = targetDirectory;

     * A loader configuration to send to stylebook; optional.
     * @param loaderConfig the configuration to use.
    public void setLoaderConfig(final String loaderConfig) {
        m_loaderConfig = loaderConfig;

     * call the program
     * @throws BuildException if there is a problem.
    public void execute()
         throws BuildException {

        if (null == m_targetDirectory) {
            throw new BuildException("TargetDirectory attribute not set.");

        if (null == m_skinDirectory) {
            throw new BuildException("SkinDirectory attribute not set.");

        if (null == m_book) {
            throw new BuildException("book attribute not set.");

        createArg().setValue("targetDirectory=" + m_targetDirectory);
        if (null != m_loaderConfig) {
            createArg().setValue("loaderConfig=" + m_loaderConfig);


Other Ant examples (source code examples)

Here is a short list of links related to this Ant source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.