summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/openslx/libvirt/domain/device/ControllerPci.java
blob: feb8b1adb5547627abcd9fdd65e080dba2c46068 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
package org.openslx.libvirt.domain.device;

import org.openslx.libvirt.xml.LibvirtXmlNode;

/**
 * A PCI controller device node in a Libvirt domain XML document.
 * 
 * @author Manuel Bentele
 * @version 1.0
 */
public class ControllerPci extends Controller
{
	/**
	 * Creates an empty PCI controller device.
	 */
	public ControllerPci()
	{
		super();
	}

	/**
	 * Creates a PCI controller device representing an existing Libvirt XML PCI controller device
	 * element.
	 * 
	 * @param xmlNode existing Libvirt XML PCI controller device element.
	 */
	public ControllerPci( LibvirtXmlNode xmlNode )
	{
		super( xmlNode );
	}

	/**
	 * Returns model of the PCI controller.
	 * 
	 * @return model of the PCI controller.
	 */
	public Model getModel()
	{
		String model = this.getXmlElementAttributeValue( "model" );
		return Model.fromString( model );
	}

	/**
	 * Sets model for the PCI controller.
	 * 
	 * @param model model for the PCI controller.
	 */
	public void setModel( Model model )
	{
		this.setXmlElementAttributeValue( "model", model.toString() );
	}

	/**
	 * Returns emulated hardware model of the PCI controller.
	 * 
	 * @return emulated hardware model of the PCI controller.
	 */
	public String getModelEmulated()
	{
		return this.getXmlElementAttributeValue( "model", "name" );
	}

	/**
	 * Creates a non-existent PCI controller device as Libvirt XML device element.
	 * 
	 * @param xmlNode Libvirt XML node of the Libvirt XML device that is created.
	 * @return created PCI controller device instance.
	 */
	public static ControllerPci createInstance( LibvirtXmlNode xmlNode )
	{
		return ControllerPci.newInstance( xmlNode );
	}

	/**
	 * Creates a PCI controller device representing an existing Libvirt XML PCI controller device
	 * element.
	 * 
	 * @param xmlNode existing Libvirt XML PCI controller device element.
	 * @return PCI controller device instance.
	 */
	public static ControllerPci newInstance( LibvirtXmlNode xmlNode )
	{
		return new ControllerPci( xmlNode );
	}

	/**
	 * Model of PCI controller device.
	 * 
	 * @author Manuel Bentele
	 * @version 1.0
	 */
	enum Model
	{
		// @formatter:off
		PCI_ROOT                   ( "pci-root" ),
		PCI_BRDIGE                 ( "pci-bridge" ),
		PCIE_ROOT                  ( "pcie-root" ),
		PCI_DMI2BRIDGE             ( "dmi-to-pci-bridge" ),
		PCIE_ROOT_PORT             ( "pcie-root-port" ),
		PCIE_SWITCH_UPSTREAM_PORT  ( "pcie-switch-upstream-port" ),
		PCIE_SWITCH_DOWNSTREAM_PORT( "pcie-switch-downstream-port" ),
		PCI_EXPANDER_BUS           ( "pci-expander-bus" ),
		PCIE_EXPANDER_BUS          ( "pcie-expander-bus" ),
		PCIE2PCI_BRIDGE            ( "pcie-to-pci-bridge" );
		// @formatter:on

		/**
		 * Name of the PCI controller device model.
		 */
		private String model = null;

		/**
		 * Creates PCI controller device model.
		 * 
		 * @param type valid name of the PCI controller device model in a Libvirt domain XML document.
		 */
		Model( String model )
		{
			this.model = model;
		}

		@Override
		public String toString()
		{
			return this.model;
		}

		/**
		 * Creates PCI controller device model from its name with error check.
		 * 
		 * @param type name of the PCI controller device model in a Libvirt domain XML document.
		 * @return valid PCI controller device model.
		 */
		public static Model fromString( String model )
		{
			for ( Model t : Model.values() ) {
				if ( t.model.equalsIgnoreCase( model ) ) {
					return t;
				}
			}

			return null;
		}
	}
}