PackageInfoTestCase.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008 Sun Microsystems, Inc.
* Portions Copyright 2015 ForgeRock AS
*/
/**
* This class provides a test case that can be used to ensure that all source
* packages also include a package-info.java file with javadoc and annotation
* information about that package.
*/
public class PackageInfoTestCase
extends UtilTestCase
{
// The directory that serves as the top-level source root.
private File sourceRoot;
/**
* Ensure that the source root directories are initialized properly.
*/
public void setUp()
{
}
/**
* Retrieves a set of File objects that point to directories that contain ADS
* source.
*
* @return A set of File objects that point to directories that contain ADS
* source.
*/
public Object[][] getADSSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* admin source.
*
* @return A set of File objects that point to directories that contain
* admin source.
*/
public Object[][] getAdminSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* build tools source.
*
* @return A set of File objects that point to directories that contain build
* tools source.
*/
public Object[][] getBuildToolsSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* DSML gateway source.
*
* @return A set of File objects that point to directories that contain
* DSML gateway source.
*/
public Object[][] getDSMLSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* GUI tools source.
*
* @return A set of File objects that point to directories that contain
* GUI tools source.
*/
public Object[][] getGUIToolsSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* QuickSetup source.
*
* @return A set of File objects that point to directories that contain
* server source.
*/
public Object[][] getQuickSetupSourceDirectories()
{
{
}
return returnArray;
}
/**
* Retrieves a set of File objects that point to directories that contain
* server source.
*
* @return A set of File objects that point to directories that contain
* server source.
*/
public Object[][] getServerSourceDirectories()
{
{
}
return returnArray;
}
/**
* Recursively descends the filesystem structure, identifying directories that
* contain Java source code and adding them to the provided list.
*
* @param startingPoint The directory that marks the starting point at
* which to begin.
* @param sourceDirectories The list of identified source directories, to
* which any new source directories will be added.
*/
{
boolean added = false;
{
if (f.isDirectory())
{
{
}
}
{
if (! added)
{
added = true;
}
}
}
}
/**
* Ensure that all ADS source file packages include a package-info.java
* file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all admin source file packages include a package-info.java
* file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all build tools source file packages include a
* package-info.java file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all DSML gateway source file packages include a
* package-info.java file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all GUI tools source file packages include a package-info.java
* file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all QuickSetup source file packages include a package-info.java
* file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that all server source file packages include a package-info.java
* file.
*
* @param sourceDirectory The directory for which to make the determination.
*/
throws Exception
{
}
/**
* Ensure that the provided source directory contains a package-info.java
* file.
*
* @param sourceDirectory The directory in which to verify the existence of
* a package-info.java file.
*/
{
" does not contain a package-info.java file.");
}
}