com.diozero.internal.provider.AbstractDevice Maven / Gradle / Ivy
package com.diozero.internal.provider;
/*
* #%L
* Organisation: diozero
* Project: Device I/O Zero - Core
* Filename: AbstractDevice.java
*
* This file is part of the diozero project. More information about this project
* can be found at http://www.diozero.com/
* %%
* Copyright (C) 2016 - 2020 diozero
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import org.tinylog.Logger;
import com.diozero.util.RuntimeIOException;
public abstract class AbstractDevice implements DeviceInterface {
private String key;
private DeviceFactoryInterface deviceFactory;
public AbstractDevice(String key, DeviceFactoryInterface deviceFactory) {
this.key = key;
this.deviceFactory = deviceFactory;
}
@Override
public final String getKey() {
return key;
}
@Override
public boolean isOpen() {
return deviceFactory.isDeviceOpened(key);
}
@Override
public final void close() {
Logger.trace("close(), key={}", key);
if (! isOpen()) {
Logger.warn("Device '{}' already closed", key);
return;
}
try {
closeDevice();
} catch (RuntimeIOException e) {
Logger.error(e, "Error closing device {}: {}", key, e);
}
deviceFactory.deviceClosed(this);
}
protected DeviceFactoryInterface getDeviceFactory() {
return deviceFactory;
}
protected abstract void closeDevice() throws RuntimeIOException;
}