1/*
2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.media.sound;
27
28import javax.sound.midi.MidiDevice;
29import javax.sound.midi.MidiDeviceTransmitter;
30import javax.sound.midi.Receiver;
31import javax.sound.midi.Transmitter;
32
33/**
34 * Helper class which allows to convert {@code Transmitter}
35 * to {@code MidiDeviceTransmitter}.
36 *
37 * @author Alex Menkov
38 */
39public final class MidiDeviceTransmitterEnvelope implements MidiDeviceTransmitter {
40
41    private final MidiDevice device;
42    private final Transmitter transmitter;
43
44    /**
45     * Creates a new {@code MidiDeviceTransmitterEnvelope} object which
46     * envelops the specified {@code Transmitter}
47     * and is owned by the specified {@code MidiDevice}.
48     *
49     * @param device the owner {@code MidiDevice}
50     * @param transmitter the {@code Transmitter} to be enveloped
51     */
52    public MidiDeviceTransmitterEnvelope(MidiDevice device, Transmitter transmitter) {
53        if (device == null || transmitter == null) {
54            throw new NullPointerException();
55        }
56        this.device = device;
57        this.transmitter = transmitter;
58    }
59
60    // Transmitter implementation
61    @Override
62    public void setReceiver(Receiver receiver) {
63        transmitter.setReceiver(receiver);
64    }
65
66    @Override
67    public Receiver getReceiver() {
68        return transmitter.getReceiver();
69    }
70
71    @Override
72    public void close() {
73        transmitter.close();
74    }
75
76    // MidiDeviceReceiver implementation
77    @Override
78    public MidiDevice getMidiDevice() {
79        return device;
80    }
81
82    /**
83     * Obtains the transmitter enveloped
84     * by this {@code MidiDeviceTransmitterEnvelope} object.
85     *
86     * @return the enveloped transmitter
87     */
88    public Transmitter getTransmitter() {
89        return transmitter;
90    }
91}
92