com.embeddedunveiled.serial.bluetooth.SerialComBluetoothAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
 * Author : Rishi Gupta
 * 
 * This file is part of 'serial communication manager' library.
 * Copyright (C) <2014-2016>  
 *
 * This 'serial communication manager' is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The 'serial communication manager' is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 
 * A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with 'serial communication manager'.  If not, see .
 */

package com.embeddedunveiled.serial.bluetooth;

/**
 * Represents the local device Bluetooth adapter and information about it.
 * 
 * @author Rishi Gupta
 */
public final class SerialComBluetoothAdapter {

	private String name;
	private String address;
	private String type;
	private String bus;

	/**
	 * Construct and allocates a new SerialComBluetoothAdapter object with given details.
	 * 
	 * @param name friendly name of this adaptor.
	 * @param address bluetooth address.
	 */
	public SerialComBluetoothAdapter(String name, String address, String type, String bus) {
		this.name = name;
		this.address = address;
		this.type = type;
		this.bus = bus;
	}

	/**
	 * Get the friendly Bluetooth name of the local Bluetooth adapter. 
	 * This name is visible to remote Bluetooth devices.
	 *
	 * @return the Bluetooth name or null on error.
	 */
	public String getName() {
		return name;
	}

	/**
	 * Returns the hardware address of the local Bluetooth adapter 
	 * for example "00:11:22:AA:BB:CC".
	 *
	 * @return Bluetooth hardware address as string.
	 */
	public String getAddress() {
		return address;
	}

	/**
	 * Returns the type of this device.
	 *
	 * @return the type or null on error.
	 */
	public String getType() {
		return name;
	}

	/**
	 * Gives information about which bus this device is connected to.
	 *
	 * @return bus type.
	 */
	public String getBus() {
		return address;
	}

	/** 
	 * Prints information about this Bluetooth adaptor on console.
	 */
	public void dumpDeviceInfo() {
		System.out.println(
				"Name : " + name + 
				"\nAddress : " + address + 
				"\nType : " + type + 
				"\nBus : " + bus);
	}
}