blob: 8cb81cbc773c2cc8b2c4f9f0e7946bfa10acc4e4 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package org.relaxng.datatype;
27
28/**
29 * A Datatype library
30 *
31 * @author <a href="mailto:jjc@jclark.com">James Clark</a>
32 * @author <a href="mailto:kohsuke.kawaguchi@sun.com">Kohsuke KAWAGUCHI</a>
33 */
34public interface DatatypeLibrary {
35
36 /**
37 * Creates a new instance of DatatypeBuilder.
38 *
39 * The callee should throw a DatatypeException in case of an error.
40 *
41 * @param baseTypeLocalName
42 * The local name of the base type.
43 *
44 * @return
45 * A non-null valid datatype object.
46 */
47 DatatypeBuilder createDatatypeBuilder( String baseTypeLocalName )
48 throws DatatypeException;
49
50 /**
51 * Gets or creates a pre-defined type.
52 *
53 * This is just a short-cut of
54 * <code>createDatatypeBuilder(typeLocalName).createDatatype();</code>
55 *
56 * The callee should throw a DatatypeException in case of an error.
57 *
58 * @return
59 * A non-null valid datatype object.
60 */
61 Datatype createDatatype( String typeLocalName ) throws DatatypeException;
62}