View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors. 
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.sequencer.classfile;
25  
26  import net.jcip.annotations.ThreadSafe;
27  import org.modeshape.graph.sequencer.SequencerOutput;
28  import org.modeshape.graph.sequencer.StreamSequencer;
29  import org.modeshape.graph.sequencer.StreamSequencerContext;
30  import org.modeshape.sequencer.classfile.metadata.ClassMetadata;
31  
32  /**
33   * A simple interface that allows an implementer to control how class file metadata mapped to properties (including primary and
34   * mixin types) in the graph.
35   * <p>
36   * Implementations of this class must provide a public, no-argument constructor.
37   * </p>
38   * <p>
39   * To use, supply the implementation class name to a {@link ClassFileSequencer} object. Each instance will be reused for multiple
40   * {@link ClassFileSequencer#sequence(java.io.InputStream, SequencerOutput, StreamSequencerContext) sequence calls}, so
41   * implementations of this interface <b>must</b> be thread-safe.
42   * </p>
43   */
44  @ThreadSafe
45  public interface ClassFileRecorder {
46  
47      /**
48       * Records a row using the provided {@link SequencerOutput} instance.
49       * 
50       * @param context the sequencer context
51       * @param output the {@link StreamSequencer} output
52       * @param classMetadata the metadata for the class file
53       */
54      void recordClass( StreamSequencerContext context,
55                        SequencerOutput output,
56                        ClassMetadata classMetadata );
57  }