View Javadoc
1   /*
2    * Copyright 2005-2008 Werner Guttmann
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.exolab.castor.builder.printing;
17  
18  /**
19   * Factory class to create {@link JClassPrinter} instances.
20   * 
21   * @since 1.2.1
22   */
23  public interface JClassPrinterFactory {
24  
25      /**
26       * Returns a short name for this {@link JClassPrinterFactory} instance.
27       * @return a short name (used for setting the JClassPrinter type on the {@link SourceGenerator}.
28       * 
29       * @see SourceGenerator#setJClassPrinterType(String)
30       */
31      String getName();
32      
33      /**
34       * Returns the {@link JClassPrinter} instance as identified by this {@link JClassPrinterFactory}
35       * instance.
36       * @return Returns the actual {@link JClassPrinter} instance 
37       */
38      JClassPrinter getJClassPrinter();
39      
40  }