1 // SECTION-START[License Header]
2 // <editor-fold defaultstate="collapsed" desc=" Generated License ">
3 /*
4 * Copyright (c) 2010 The JOMC Project
5 * Copyright (c) 2005 Christian Schulte <schulte2005@users.sourceforge.net>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * o Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * o Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE JOMC PROJECT AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE JOMC PROJECT OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
30 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $Id: SequenceMapper.java 2247 2010-06-29 08:01:42Z schulte2005 $
33 *
34 */
35 // </editor-fold>
36 // SECTION-END
37 package org.jomc.sequences.ri;
38
39 import org.jomc.sequences.Sequence;
40 import org.jomc.sequences.SequencesSystemException;
41 import org.jomc.sequences.model.SequenceType;
42
43 // SECTION-START[Documentation]
44 // <editor-fold defaultstate="collapsed" desc=" Generated Documentation ">
45 /**
46 * Maps model classes.
47 *
48 * <p>
49 * This specification declares a multiplicity of {@code Many}.
50 * An application assembler may provide multiple implementations of this specification (including none).
51 * </p>
52 *
53 * <p>
54 * Use of class {@link org.jomc.ObjectManager ObjectManager} is supported for accessing implementations.
55 * <pre>
56 * SequenceMapper[] objects = ObjectManagerFactory.getObjectManager( getClass().getClassLoader() ).getObject( SequenceMapper[].class );
57 * SequenceMapper object = ObjectManagerFactory.getObjectManager( getClass().getClassLoader() ).getObject( SequenceMapper.class, "<i>implementation name</i>" );
58 * </pre>
59 * </p>
60 *
61 * <p>
62 * This specification does not apply to any scope. A new object is returned whenever requested.
63 * </p>
64 *
65 * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a> 1.0
66 * @version $Id: SequenceMapper.java 2247 2010-06-29 08:01:42Z schulte2005 $
67 */
68 // </editor-fold>
69 // SECTION-END
70 // SECTION-START[Annotations]
71 // <editor-fold defaultstate="collapsed" desc=" Generated Annotations ">
72 @javax.annotation.Generated( value = "org.jomc.tools.SourceFileProcessor 1.0", comments = "See http://jomc.sourceforge.net/jomc/1.0/jomc-tools" )
73 // </editor-fold>
74 // SECTION-END
75 public interface SequenceMapper
76 {
77 // SECTION-START[SequenceMapper]
78
79 /**
80 * Maps a {@code SequenceType} instance to a {@code Sequence} instance.
81 *
82 * @param sequenceType The instance to map.
83 * @param sequence The target instance to map {@code sequenceType} to.
84 *
85 * @return {@code sequenceType} mapped to {@code sequence}.
86 *
87 * @throws SequencesSystemException if mapping fails unexpectedly.
88 */
89 Sequence map( SequenceType sequenceType, Sequence sequence ) throws SequencesSystemException;
90
91 /**
92 * Maps a {@code Sequence} instance to a {@code SequenceType} instance.
93 *
94 * @param sequence The instance to map.
95 * @param sequenceType The target instance to map {@code sequence} to.
96 *
97 * @return {@code sequence} mapped to {@code sequenceType}.
98 *
99 * @throws SequencesSystemException if mapping fails unexpectedly.
100 */
101 SequenceType map( Sequence sequence, SequenceType sequenceType ) throws SequencesSystemException;
102
103 // SECTION-END
104 }