Documentation mania!
git-svn-id: https://samskivert.googlecode.com/svn/trunk@236 6335cc39-0255-0410-8fd6-9bcaacd3b74c
This commit is contained in:
mdb
@@ -1,40 +1,43 @@
|
||||
<!-- build configuration -->
|
||||
<project name="samskivert" default="compile" basedir=".">
|
||||
|
||||
<!-- configuration parameters -->
|
||||
<!-- things you may want to change -->
|
||||
<property name="app.name" value="samskivert"/>
|
||||
<property name="deploy.home" value="dist"/>
|
||||
<property name="dist.home" value="${deploy.home}"/>
|
||||
<property name="dist.jar" value="${app.name}.jar"/>
|
||||
<property name="javadoc.home" value="${deploy.home}/docs"/>
|
||||
<property name="build.compiler" value="jikes"/>
|
||||
<property name="java.libraries" value="/usr/share/java"/>
|
||||
<property name="doc.packages" value="com.samskivert.*"/>
|
||||
<property name="copyright.holder" value="Michael Bayne"/>
|
||||
|
||||
<!-- things you probably don't want to change -->
|
||||
<property name="deploy.dir" value="dist"/>
|
||||
<property name="dist.jar" value="${app.name}.jar"/>
|
||||
<property name="javadoc.dir" value="${deploy.dir}/docs"/>
|
||||
|
||||
<!-- declare our classpath -->
|
||||
<path id="classpath">
|
||||
<fileset dir="${java.libraries}" includes="**/*.jar"/>
|
||||
<fileset dir="lib" includes="**/*.jar"/>
|
||||
<pathelement location="${deploy.home}/classes"/>
|
||||
<pathelement location="${deploy.dir}/classes"/>
|
||||
</path>
|
||||
|
||||
<!-- prepares the application directories -->
|
||||
<target name="prepare">
|
||||
<mkdir dir="${deploy.home}"/>
|
||||
<mkdir dir="${deploy.home}/classes"/>
|
||||
<mkdir dir="${javadoc.home}"/>
|
||||
<copy todir="${deploy.home}/classes">
|
||||
<mkdir dir="${deploy.dir}"/>
|
||||
<mkdir dir="${deploy.dir}/classes"/>
|
||||
<mkdir dir="${javadoc.dir}"/>
|
||||
<copy todir="${deploy.dir}/classes">
|
||||
<fileset dir="src/java" includes="**/*.properties"/>
|
||||
</copy>
|
||||
</target>
|
||||
|
||||
<!-- cleans out the installed application -->
|
||||
<target name="clean">
|
||||
<delete dir="${deploy.home}"/>
|
||||
<delete dir="${deploy.dir}"/>
|
||||
</target>
|
||||
|
||||
<!-- build the java class files -->
|
||||
<target name="compile" depends="prepare">
|
||||
<javac srcdir="src/java" destdir="${deploy.home}/classes"
|
||||
<javac srcdir="src/java" destdir="${deploy.dir}/classes"
|
||||
debug="on" optimize="off" deprecation="off">
|
||||
<classpath refid="classpath"/>
|
||||
</javac>
|
||||
@@ -43,8 +46,11 @@
|
||||
<!-- build the javadoc documentation -->
|
||||
<target name="javadoc" depends="prepare">
|
||||
<javadoc sourcepath="src/java"
|
||||
packagenames="com.samskivert.*"
|
||||
destdir="${javadoc.home}">
|
||||
packagenames="${doc.packages}"
|
||||
windowtitle="${app.name} API"
|
||||
doctitle="${app.name} API"
|
||||
bottom="Copyright © 2001 ${copyright.holder}. All Rights Reserved."
|
||||
destdir="${javadoc.dir}">
|
||||
<classpath refid="classpath"/>
|
||||
<link href="http://java.sun.com/products/jdk/1.3/docs/api"/>
|
||||
</javadoc>
|
||||
@@ -55,8 +61,8 @@
|
||||
|
||||
<!-- builds our distribution files (war and jar) -->
|
||||
<target name="dist" depends="prepare,compile">
|
||||
<jar jarfile="${dist.home}/${dist.jar}"
|
||||
basedir="${deploy.home}/classes"/>
|
||||
<jar jarfile="${deploy.dir}/${dist.jar}"
|
||||
basedir="${deploy.dir}/classes"/>
|
||||
</target>
|
||||
|
||||
</project>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: Log.java,v 1.2 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: Log.java,v 1.3 2001/08/12 01:34:30 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -22,10 +22,26 @@ package com.samskivert;
|
||||
|
||||
/**
|
||||
* A placeholder class that contains a reference to the log object used by
|
||||
* the samskivert package.
|
||||
* the samskivert package. This is a useful pattern to use when using the
|
||||
* samskivert logging facilities. One creates a top-level class like this
|
||||
* one that instantiates a log object with an name that identifies log
|
||||
* messages from that package and then provides static methods that
|
||||
* generate log messages using that instance. Then, classes in that
|
||||
* package need only import the log wrapper class and can easily use it to
|
||||
* generate log messages. For example:
|
||||
*
|
||||
* <pre>
|
||||
* import com.samskivert.Log;
|
||||
* // ...
|
||||
* Log.warning("All hell is breaking loose!");
|
||||
* // ...
|
||||
* </pre>
|
||||
*
|
||||
* @see com.samskivert.util.Log
|
||||
*/
|
||||
public class Log
|
||||
{
|
||||
/** The static log instance configured for use by this package. */
|
||||
public static com.samskivert.util.Log log =
|
||||
new com.samskivert.util.Log("samskivert");
|
||||
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:30 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides a mapping between JDBC tables and Java objects.
|
||||
|
||||
<p> This is a hacked version of JORA 2.06, a library for automatically
|
||||
mapping RDBMS database rows to Java objects and vice versa. It's
|
||||
simple, it uses reflection and doesn't require any classfile
|
||||
post-processing or external configuration information.
|
||||
|
||||
<p> "That's all great but why is it hacked?" wonders the astute
|
||||
reader. Well, I couldn't quite cope with the error handling paradigm
|
||||
that it used (catch all SQL exceptions internally and pass them to
|
||||
an application-wide error handler method) and a few seconds thought
|
||||
on the matter led me to believe that there is not a simple way to
|
||||
allow a choice of error handling paradigms (the methods have to
|
||||
throw SQLException or not). So I took the easy way out and forked
|
||||
the codebase.
|
||||
|
||||
<p> The code is pretty stable, so I don't expect to be merging in
|
||||
updates with any frequency. I promise to be a good monkey and submit
|
||||
any useful modifications that I make back to the original
|
||||
maintainer. Fortunately the license was unrestrictive enough to
|
||||
allow me to do this, otherwise I'd probably be stuck reinventing the
|
||||
wheel or using something that does less of what I want. Three cheers
|
||||
for free software.
|
||||
|
||||
<p> The JORA package was written by Konstantin Knizhnik and the
|
||||
original is available from
|
||||
<a href="http://www.ispras.ru/~knizhnik/">his web site.</a>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:30 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides support services to applications that access relational
|
||||
databases via JDBC.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: CDDB.java,v 1.7 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: CDDB.java,v 1.8 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -50,6 +50,11 @@ public class CDDB
|
||||
*/
|
||||
public static String CLIENT_VERSION; // assigned during static init
|
||||
|
||||
/**
|
||||
* This class encapsulates the information needed to look up a full
|
||||
* CDDB record for a particular disc. An array of them are returned in
|
||||
* response to a CDDB query.
|
||||
*/
|
||||
public static class Entry
|
||||
{
|
||||
/** The category to which this entry belongs. */
|
||||
@@ -500,7 +505,7 @@ public class CDDB
|
||||
*/
|
||||
static
|
||||
{
|
||||
StringTokenizer tok = new StringTokenizer("$Revision: 1.7 $");
|
||||
StringTokenizer tok = new StringTokenizer("$Revision: 1.8 $");
|
||||
tok.nextToken();
|
||||
CLIENT_VERSION = tok.nextToken();
|
||||
}
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Routines for accessing a CDDB server.
|
||||
|
||||
<p> The {@link com.samskivert.net.cddb.CDDB} class provides the
|
||||
primary interface to the CDDB services. This service does not
|
||||
provide a means to obtain the CD identification information that
|
||||
you'll need to perform a CDDB lookup. In the application that
|
||||
motivated the creation of these services, a <code>cdparanoia</code>
|
||||
process was spawned to read the disc info. Other mechanisms surely
|
||||
exist.
|
||||
|
||||
<p> Use of the CDDB class is fairly straightforward:
|
||||
|
||||
<pre>
|
||||
CDDB cddb = new CDDB();
|
||||
cddb.connect("www.freedb.org");
|
||||
CDDB.Entry[] entries = cddb.query(discid, frameOffsets, length);
|
||||
for (int i = 0; i < entries.length; i++) {
|
||||
CDDB.Detail detail = cddb.read(entries[i].category,
|
||||
entries[i].discid);
|
||||
// do your thang now...
|
||||
}
|
||||
</pre>
|
||||
|
||||
<p> These services presently do not provide a mechanism for submitting
|
||||
a CDDB entry (which involves sending an email). It surely will in
|
||||
the future.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides a network related services and patterns.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:30 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Nothing lives here except the {@link com.samskivert.util.Log} wrapper
|
||||
that is used by the samskivert services to generate log messages.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides services and patterns that are useful in developing web
|
||||
applications.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
+4
-1
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: InvalidPasswordException.java,v 1.2 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: InvalidPasswordException.java,v 1.3 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -20,6 +20,9 @@
|
||||
|
||||
package com.samskivert.servlet.user;
|
||||
|
||||
/**
|
||||
* Thrown during authentication when an invalid password is supplied.
|
||||
*/
|
||||
public class InvalidPasswordException extends Exception
|
||||
{
|
||||
public InvalidPasswordException (String message)
|
||||
|
||||
+4
-1
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: InvalidUsernameException.java,v 1.2 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: InvalidUsernameException.java,v 1.3 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -20,6 +20,9 @@
|
||||
|
||||
package com.samskivert.servlet.user;
|
||||
|
||||
/**
|
||||
* Thrown during user account creation if an invalid username is supplied.
|
||||
*/
|
||||
public class InvalidUsernameException extends Exception
|
||||
{
|
||||
public InvalidUsernameException (String message)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: NoSuchUserException.java,v 1.2 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: NoSuchUserException.java,v 1.3 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -20,6 +20,9 @@
|
||||
|
||||
package com.samskivert.servlet.user;
|
||||
|
||||
/**
|
||||
* Thrown when a user cannot be located in the user database.
|
||||
*/
|
||||
public class NoSuchUserException extends Exception
|
||||
{
|
||||
public NoSuchUserException (String message)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: UserExistsException.java,v 1.2 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: UserExistsException.java,v 1.3 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -20,6 +20,10 @@
|
||||
|
||||
package com.samskivert.servlet.user;
|
||||
|
||||
/**
|
||||
* Thrown during user account creation when a user with the requested
|
||||
* username already exists.
|
||||
*/
|
||||
public class UserExistsException extends Exception
|
||||
{
|
||||
public UserExistsException (String message)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: UserRepository.java,v 1.14 2001/08/11 22:43:28 mdb Exp $
|
||||
// $Id: UserRepository.java,v 1.15 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -33,6 +33,11 @@ import com.samskivert.jdbc.MySQLRepository;
|
||||
import com.samskivert.jdbc.jora.*;
|
||||
import com.samskivert.util.IntMap;
|
||||
|
||||
/**
|
||||
* Interfaces with the RDBMS in which the user information is stored. The
|
||||
* user repository encapsulates the creating, loading and management of
|
||||
* users and sessions.
|
||||
*/
|
||||
public class UserRepository extends MySQLRepository
|
||||
{
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides services for managing a database of users in a web
|
||||
application or suite of web applications.
|
||||
|
||||
<p> This is accomplished through the
|
||||
{@link com.samskivert.servlet.user.UserManager} which can be used to
|
||||
load user objects, create new users, update existing users and
|
||||
generally all of the user-related things that you'd like to do. The
|
||||
user manager manages cookies for persistent or session-only
|
||||
authentication and provides support for requiring that a user be
|
||||
authenticated in order to access a page.
|
||||
|
||||
<p> The user manager stores user information in an SQL database which
|
||||
is accomplished by the
|
||||
{@link com.samskivert.servlet.user.UserRepository} class. Presently,
|
||||
it assumes that it is making use of a MySQL database, but the
|
||||
dependencies are minimal. Eventually I'll modify the repository
|
||||
abstraction so that the database-specific support code can be chosen
|
||||
at runtime rather than compile time. Why I designed it the way it is
|
||||
in the first place, I can't imagine. I'm a bad monkey.
|
||||
|
||||
<p> The user table (and associated
|
||||
{@link com.samskivert.servlet.user.User} object) are inentionally
|
||||
minimal. The expectation is that application specific data will be
|
||||
stored and accessed via some other table that is keyed on the userid
|
||||
provided by these services.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides servlet-related utilities.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides extensions and patterns for building user interfaces with
|
||||
Swing.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,8 +1,8 @@
|
||||
//
|
||||
// $Id: MenuUtil.java,v 1.2 2001/08/11 22:43:29 mdb Exp $
|
||||
// $Id: MenuUtil.java,v 1.3 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
// Copyright (C) 2001 Walter Korman
|
||||
//
|
||||
// This library is free software; you can redistribute it and/or modify it
|
||||
// under the terms of the GNU Lesser General Public License as published
|
||||
@@ -31,10 +31,10 @@ import javax.swing.*;
|
||||
* menu in a frame that listens to its own menus (a common case) can
|
||||
* be simplified like so:
|
||||
*
|
||||
* <code>
|
||||
* <pre>
|
||||
* accel = KeyStroke.getKeyStroke(KeyEvent.VK_N, ActionEvent.ALT_MASK);
|
||||
* MenuUtil.addMenuItem(this, menuFile, "New", KeyEvent.VK_N, acc);
|
||||
* </code>
|
||||
* </pre>
|
||||
*/
|
||||
public class MenuUtil
|
||||
{
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides Swing-related utility services.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,5 +1,5 @@
|
||||
//
|
||||
// $Id: Log.java,v 1.4 2001/08/11 22:43:29 mdb Exp $
|
||||
// $Id: Log.java,v 1.5 2001/08/12 01:34:31 mdb Exp $
|
||||
//
|
||||
// samskivert library - useful routines for java programs
|
||||
// Copyright (C) 2001 Michael Bayne
|
||||
@@ -24,7 +24,7 @@ package com.samskivert.util;
|
||||
* The log services provide debug, info and warning message logging
|
||||
* capabilities for a set of modules. These log services are designed to
|
||||
* provide the basic functionality needed by the samskivert codebase. It
|
||||
* is expected that the <code>LogProvider</code> interface will be used to
|
||||
* is expected that the {@link LogProvider} interface will be used to
|
||||
* map these log services onto whatever more general purpose logging
|
||||
* framework is in use by the user of the samskivert codebase.
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides a variety of utility services including data structures,
|
||||
synchronization support, text processing and more.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,54 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides parts of a simple web application framework built around the
|
||||
WebMacro template engine.
|
||||
|
||||
<p> The web application framework provided by this package is simple
|
||||
and intended for use in small projects with limited scope. It is not
|
||||
intended to be all things, nor to evolve into something that makes
|
||||
toast. It builds upon WebMacro, a template engine whose
|
||||
<a href="http://www.webmacro.org/WebMacroMotivation">philosophies</a>
|
||||
about the separation of markup and code I agree with.
|
||||
|
||||
<p> WebMacro is designed to be used explicitly by servlets in
|
||||
applications where the design is structured around the servlets
|
||||
rather than the pages generated by the servlets. This is in contrast
|
||||
to the JSP approach where the pages themselves dictate the structure
|
||||
of the application and the servlets are automatically generated to
|
||||
conform to that structure. This package provides a means by which to
|
||||
automatically map serlvet-like units of code to templates in a way
|
||||
akin to JSP's approach but without the combination of code and
|
||||
markup.
|
||||
|
||||
<p>I'd document this more, but I'm probably going to start using
|
||||
<a href="http://jakarta.apache.org/turbine/">Turbine</a> and abandon
|
||||
this framework next time I get around to working on web
|
||||
applications.
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,32 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
|
||||
$Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
|
||||
|
||||
samskivert library - useful routines for java programs
|
||||
Copyright (C) 2001 Michael Bayne
|
||||
|
||||
This library 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 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This library 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 library; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
-->
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
|
||||
Provides XML related services.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user