chengfan
Committed by Gerrit Code Review

Optimized the pcep api

1.remove the "public" in the interface
2.remove the "static" in the enum

Change-Id: I782ec94581a7f8ef08280444f237a9a21f2f1807

Optimized the pcep api

1.remove the "public" in the interface
2.remove the "static" in the enum

Change-Id: I782ec94581a7f8ef08280444f237a9a21f2f1807
...@@ -28,7 +28,7 @@ public interface PcepController { ...@@ -28,7 +28,7 @@ public interface PcepController {
28 * 28 *
29 * @return Iterable of did elements 29 * @return Iterable of did elements
30 */ 30 */
31 - public Iterable<PcepSwitch> getSwitches(); 31 + Iterable<PcepSwitch> getSwitches();
32 32
33 /** 33 /**
34 * Return a switch with a specified did. 34 * Return a switch with a specified did.
...@@ -36,49 +36,49 @@ public interface PcepController { ...@@ -36,49 +36,49 @@ public interface PcepController {
36 * @param did of a device 36 * @param did of a device
37 * @return a pcep device 37 * @return a pcep device
38 */ 38 */
39 - public PcepSwitch getSwitch(PcepDpid did); 39 + PcepSwitch getSwitch(PcepDpid did);
40 40
41 /** 41 /**
42 * Register a listener for meta events that occur to PCEP devices. 42 * Register a listener for meta events that occur to PCEP devices.
43 * 43 *
44 * @param listener the listener to notify 44 * @param listener the listener to notify
45 */ 45 */
46 - public void addListener(PcepSwitchListener listener); 46 + void addListener(PcepSwitchListener listener);
47 47
48 /** 48 /**
49 * Unregister a listener. 49 * Unregister a listener.
50 * 50 *
51 * @param listener the listener to unregister 51 * @param listener the listener to unregister
52 */ 52 */
53 - public void removeListener(PcepSwitchListener listener); 53 + void removeListener(PcepSwitchListener listener);
54 54
55 /** 55 /**
56 * Register a listener for meta events that occur to PCEP links. 56 * Register a listener for meta events that occur to PCEP links.
57 * 57 *
58 * @param listener the listener to notify 58 * @param listener the listener to notify
59 */ 59 */
60 - public void addLinkListener(PcepLinkListener listener); 60 + void addLinkListener(PcepLinkListener listener);
61 61
62 /** 62 /**
63 * Unregister a link listener. 63 * Unregister a link listener.
64 * 64 *
65 * @param listener the listener to unregister 65 * @param listener the listener to unregister
66 */ 66 */
67 - public void removeLinkListener(PcepLinkListener listener); 67 + void removeLinkListener(PcepLinkListener listener);
68 68
69 /** 69 /**
70 * Register a listener for meta events that occur to PCEP tunnel. 70 * Register a listener for meta events that occur to PCEP tunnel.
71 * 71 *
72 * @param listener the listener to notify 72 * @param listener the listener to notify
73 */ 73 */
74 - public void addTunnelListener(PcepTunnelListener listener); 74 + void addTunnelListener(PcepTunnelListener listener);
75 75
76 /** 76 /**
77 * Unregister a tunnel listener. 77 * Unregister a tunnel listener.
78 * 78 *
79 * @param listener the listener to unregister 79 * @param listener the listener to unregister
80 */ 80 */
81 - public void removeTunnelListener(PcepTunnelListener listener); 81 + void removeTunnelListener(PcepTunnelListener listener);
82 82
83 /** 83 /**
84 * Setup a tunnel through pcep controller. 84 * Setup a tunnel through pcep controller.
...@@ -91,7 +91,7 @@ public interface PcepController { ...@@ -91,7 +91,7 @@ public interface PcepController {
91 * @param name tunnel name 91 * @param name tunnel name
92 * @return pcep tunnel 92 * @return pcep tunnel
93 */ 93 */
94 - public PcepTunnel applyTunnel(DeviceId srcDid, DeviceId dstDid, 94 + PcepTunnel applyTunnel(DeviceId srcDid, DeviceId dstDid,
95 long srcPort, long dstPort, long bandwidth, 95 long srcPort, long dstPort, long bandwidth,
96 String name); 96 String name);
97 97
...@@ -101,7 +101,7 @@ public interface PcepController { ...@@ -101,7 +101,7 @@ public interface PcepController {
101 * @param id pcep tunnel id. 101 * @param id pcep tunnel id.
102 * @return true or false 102 * @return true or false
103 */ 103 */
104 - public Boolean deleteTunnel(String id); 104 + Boolean deleteTunnel(String id);
105 105
106 /** 106 /**
107 * Update tunnel bandwidth by tunnel id. 107 * Update tunnel bandwidth by tunnel id.
...@@ -110,6 +110,6 @@ public interface PcepController { ...@@ -110,6 +110,6 @@ public interface PcepController {
110 * @param bandwidth bandwidth of a tunnel 110 * @param bandwidth bandwidth of a tunnel
111 * @return true or false 111 * @return true or false
112 */ 112 */
113 - public Boolean updateTunnelBandwidth(String id, long bandwidth); 113 + Boolean updateTunnelBandwidth(String id, long bandwidth);
114 114
115 } 115 }
......
...@@ -22,7 +22,7 @@ import org.onosproject.net.Port; ...@@ -22,7 +22,7 @@ import org.onosproject.net.Port;
22 */ 22 */
23 public interface PcepLink extends PcepOperator { 23 public interface PcepLink extends PcepOperator {
24 24
25 - public enum SubType { 25 + enum SubType {
26 /** 26 /**
27 * Optical Transmission Section Link. 27 * Optical Transmission Section Link.
28 */ 28 */
...@@ -50,7 +50,7 @@ public interface PcepLink extends PcepOperator { ...@@ -50,7 +50,7 @@ public interface PcepLink extends PcepOperator {
50 } 50 }
51 51
52 52
53 - public enum PortType { 53 + enum PortType {
54 ODU_PORT, OCH_PORT, OMS_PORT 54 ODU_PORT, OCH_PORT, OMS_PORT
55 } 55 }
56 56
...@@ -59,7 +59,7 @@ public interface PcepLink extends PcepOperator { ...@@ -59,7 +59,7 @@ public interface PcepLink extends PcepOperator {
59 * 59 *
60 * @return endpoint port type 60 * @return endpoint port type
61 */ 61 */
62 - public PortType portType(); 62 + PortType portType();
63 63
64 /** 64 /**
65 * Returns the link sub type,OTS,OPS,PKT_OPTICAL or ODUK. 65 * Returns the link sub type,OTS,OPS,PKT_OPTICAL or ODUK.
...@@ -67,21 +67,21 @@ public interface PcepLink extends PcepOperator { ...@@ -67,21 +67,21 @@ public interface PcepLink extends PcepOperator {
67 * @return link subType 67 * @return link subType
68 */ 68 */
69 69
70 - public SubType linkSubType(); 70 + SubType linkSubType();
71 71
72 /** 72 /**
73 * Returns the link state, up or down. 73 * Returns the link state, up or down.
74 * 74 *
75 * @return link state 75 * @return link state
76 */ 76 */
77 - public String linkState(); 77 + String linkState();
78 78
79 /** 79 /**
80 * Returns the distance of a link. 80 * Returns the distance of a link.
81 * 81 *
82 * @return distance 82 * @return distance
83 */ 83 */
84 - public int linkDistance(); 84 + int linkDistance();
85 85
86 /** 86 /**
87 * Returns the capacity type of a link,1: WAVELENGTHNUM, 2:SLOTNUM, 3, 87 * Returns the capacity type of a link,1: WAVELENGTHNUM, 2:SLOTNUM, 3,
...@@ -89,48 +89,48 @@ public interface PcepLink extends PcepOperator { ...@@ -89,48 +89,48 @@ public interface PcepLink extends PcepOperator {
89 * 89 *
90 * @return capacity type 90 * @return capacity type
91 */ 91 */
92 - public String linkCapacityType(); 92 + String linkCapacityType();
93 93
94 /** 94 /**
95 * Returns the available capacity value ,such as available bandwidth. 95 * Returns the available capacity value ,such as available bandwidth.
96 * 96 *
97 * @return availValue 97 * @return availValue
98 */ 98 */
99 - public int linkAvailValue(); 99 + int linkAvailValue();
100 100
101 /** 101 /**
102 * Returns the max capacity value ,such as max bandwidth. 102 * Returns the max capacity value ,such as max bandwidth.
103 * 103 *
104 * @return maxValue 104 * @return maxValue
105 */ 105 */
106 - public int linkMaxValue(); 106 + int linkMaxValue();
107 107
108 /** 108 /**
109 * Returns the source device did of a link. 109 * Returns the source device did of a link.
110 * 110 *
111 * @return source did 111 * @return source did
112 */ 112 */
113 - public PcepDpid linkSrcDeviceID(); 113 + PcepDpid linkSrcDeviceID();
114 114
115 /** 115 /**
116 * Returns the destination device did of a link. 116 * Returns the destination device did of a link.
117 * 117 *
118 * @return destination did 118 * @return destination did
119 */ 119 */
120 - public PcepDpid linkDstDeviceId(); 120 + PcepDpid linkDstDeviceId();
121 121
122 /** 122 /**
123 * Returns the source port of a link. 123 * Returns the source port of a link.
124 * 124 *
125 * @return port number 125 * @return port number
126 */ 126 */
127 - public Port linkSrcPort(); 127 + Port linkSrcPort();
128 128
129 /** 129 /**
130 * Returns the destination port of a link. 130 * Returns the destination port of a link.
131 * 131 *
132 * @return port number 132 * @return port number
133 */ 133 */
134 - public Port linkDstPort(); 134 + Port linkDstPort();
135 135
136 } 136 }
......
...@@ -26,5 +26,5 @@ public interface PcepLinkListener { ...@@ -26,5 +26,5 @@ public interface PcepLinkListener {
26 * 26 *
27 * @param link pcep link 27 * @param link pcep link
28 */ 28 */
29 - public void handlePCEPlink(PcepLink link); 29 + void handlePCEPlink(PcepLink link);
30 } 30 }
......
...@@ -18,11 +18,10 @@ package org.onosproject.pcep.api; ...@@ -18,11 +18,10 @@ package org.onosproject.pcep.api;
18 /** 18 /**
19 * A interface defined operator type, and provide a method to get the operator 19 * A interface defined operator type, and provide a method to get the operator
20 * type. 20 * type.
21 - *
22 */ 21 */
23 public interface PcepOperator { 22 public interface PcepOperator {
24 23
25 - public enum OperationType { 24 + enum OperationType {
26 25
27 ADD, UPDATE, DELETE, 26 ADD, UPDATE, DELETE,
28 } 27 }
...@@ -32,5 +31,5 @@ public interface PcepOperator { ...@@ -32,5 +31,5 @@ public interface PcepOperator {
32 * 31 *
33 * @return operation type. 32 * @return operation type.
34 */ 33 */
35 - public OperationType getOperationType(); 34 + OperationType getOperationType();
36 } 35 }
......
...@@ -20,7 +20,7 @@ package org.onosproject.pcep.api; ...@@ -20,7 +20,7 @@ package org.onosproject.pcep.api;
20 */ 20 */
21 public interface PcepSwitch extends PcepOperator { 21 public interface PcepSwitch extends PcepOperator {
22 22
23 - public static enum DeviceType { 23 + enum DeviceType {
24 /* optical device */ 24 /* optical device */
25 ROADM, 25 ROADM,
26 26
...@@ -38,55 +38,55 @@ public interface PcepSwitch extends PcepOperator { ...@@ -38,55 +38,55 @@ public interface PcepSwitch extends PcepOperator {
38 * Gets a string version of the ID for this switch. 38 * Gets a string version of the ID for this switch.
39 * @return string version of the ID 39 * @return string version of the ID
40 */ 40 */
41 - public String getStringId(); 41 + String getStringId();
42 42
43 /** 43 /**
44 * Gets the datapathId of the switch. 44 * Gets the datapathId of the switch.
45 * @return the switch dpid in long format 45 * @return the switch dpid in long format
46 */ 46 */
47 - public long getId(); 47 + long getId();
48 48
49 - public long getNeId(); 49 + long getNeId();
50 50
51 /** 51 /**
52 * Gets the sub type of the device. 52 * Gets the sub type of the device.
53 * @return the sub type 53 * @return the sub type
54 */ 54 */
55 - public DeviceType getDeviceType(); 55 + DeviceType getDeviceType();
56 56
57 /** 57 /**
58 * fetch the manufacturer description. 58 * fetch the manufacturer description.
59 * @return the description 59 * @return the description
60 */ 60 */
61 - public String manufacturerDescription(); 61 + String manufacturerDescription();
62 62
63 /** 63 /**
64 * fetch the datapath description. 64 * fetch the datapath description.
65 * @return the description 65 * @return the description
66 */ 66 */
67 - public String datapathDescription(); 67 + String datapathDescription();
68 68
69 /** 69 /**
70 * fetch the hardware description. 70 * fetch the hardware description.
71 * @return the description 71 * @return the description
72 */ 72 */
73 - public String hardwareDescription(); 73 + String hardwareDescription();
74 74
75 /** 75 /**
76 * fetch the software description. 76 * fetch the software description.
77 * @return the description 77 * @return the description
78 */ 78 */
79 - public String softwareDescription(); 79 + String softwareDescription();
80 80
81 /** 81 /**
82 * fetch the serial number. 82 * fetch the serial number.
83 * @return the serial 83 * @return the serial
84 */ 84 */
85 - public String serialNumber(); 85 + String serialNumber();
86 86
87 /** 87 /**
88 * Indicates if this switch is optical. 88 * Indicates if this switch is optical.
89 * @return true if optical 89 * @return true if optical
90 */ 90 */
91 - public boolean isOptical(); 91 + boolean isOptical();
92 } 92 }
......
...@@ -25,20 +25,20 @@ public interface PcepSwitchListener { ...@@ -25,20 +25,20 @@ public interface PcepSwitchListener {
25 * 25 *
26 * @param dpid the switch where the event occurred 26 * @param dpid the switch where the event occurred
27 */ 27 */
28 - public void switchAdded(PcepDpid dpid); 28 + void switchAdded(PcepDpid dpid);
29 29
30 /** 30 /**
31 * Notify that the switch was removed. 31 * Notify that the switch was removed.
32 * 32 *
33 * @param dpid the switch where the event occurred. 33 * @param dpid the switch where the event occurred.
34 */ 34 */
35 - public void switchRemoved(PcepDpid dpid); 35 + void switchRemoved(PcepDpid dpid);
36 36
37 /** 37 /**
38 * Notify that the switch has changed in some way. 38 * Notify that the switch has changed in some way.
39 * 39 *
40 * @param dpid the switch that changed 40 * @param dpid the switch that changed
41 */ 41 */
42 - public void switchChanged(PcepDpid dpid); 42 + void switchChanged(PcepDpid dpid);
43 43
44 } 44 }
......
...@@ -28,7 +28,7 @@ public interface PcepTunnel extends PcepOperator { ...@@ -28,7 +28,7 @@ public interface PcepTunnel extends PcepOperator {
28 /** 28 /**
29 * Describe the type of a tunnel. 29 * Describe the type of a tunnel.
30 */ 30 */
31 - public static enum Type { 31 + enum Type {
32 32
33 /** 33 /**
34 * Signifies that this is a L0 OCH tunnel. 34 * Signifies that this is a L0 OCH tunnel.
...@@ -49,7 +49,7 @@ public interface PcepTunnel extends PcepOperator { ...@@ -49,7 +49,7 @@ public interface PcepTunnel extends PcepOperator {
49 /** 49 /**
50 * The ability of a tunnel. 50 * The ability of a tunnel.
51 */ 51 */
52 - public static enum Ability { 52 + enum Ability {
53 /** 53 /**
54 * no protected tunnel,if the tunnel is broken ,then the user is out of 54 * no protected tunnel,if the tunnel is broken ,then the user is out of
55 * service. 55 * service.
...@@ -69,7 +69,7 @@ public interface PcepTunnel extends PcepOperator { ...@@ -69,7 +69,7 @@ public interface PcepTunnel extends PcepOperator {
69 DIAMOND 69 DIAMOND
70 } 70 }
71 71
72 - public static enum PATHTYPE { 72 + enum PATHTYPE {
73 73
74 /** 74 /**
75 * Indicates path is the preferred path. 75 * Indicates path is the preferred path.
...@@ -84,9 +84,8 @@ public interface PcepTunnel extends PcepOperator { ...@@ -84,9 +84,8 @@ public interface PcepTunnel extends PcepOperator {
84 84
85 /** 85 /**
86 * Represents state of the path, work normally or broken down. 86 * Represents state of the path, work normally or broken down.
87 - *
88 */ 87 */
89 - public static enum PathState { 88 + enum PathState {
90 NORMAL, BROKEN 89 NORMAL, BROKEN
91 } 90 }
92 91
...@@ -95,63 +94,63 @@ public interface PcepTunnel extends PcepOperator { ...@@ -95,63 +94,63 @@ public interface PcepTunnel extends PcepOperator {
95 * 94 *
96 * @return tunnel type 95 * @return tunnel type
97 */ 96 */
98 - public Type type(); 97 + Type type();
99 98
100 /** 99 /**
101 * Returns the name of a tunnel. 100 * Returns the name of a tunnel.
102 * 101 *
103 * @return tunnel name 102 * @return tunnel name
104 */ 103 */
105 - public String name(); 104 + String name();
106 105
107 /** 106 /**
108 * Returns the device id of destination endpoint of a tunnel. 107 * Returns the device id of destination endpoint of a tunnel.
109 * 108 *
110 * @return device id 109 * @return device id
111 */ 110 */
112 - public PcepDpid srcDeviceID(); 111 + PcepDpid srcDeviceID();
113 112
114 /** 113 /**
115 * Returns the device id of source endpoint of a tunnel. 114 * Returns the device id of source endpoint of a tunnel.
116 * 115 *
117 * @return device id 116 * @return device id
118 */ 117 */
119 - public PcepDpid dstDeviceId(); 118 + PcepDpid dstDeviceId();
120 119
121 /** 120 /**
122 * Returns source port of a tunnel. 121 * Returns source port of a tunnel.
123 * 122 *
124 * @return port number 123 * @return port number
125 */ 124 */
126 - public long srcPort(); 125 + long srcPort();
127 126
128 /** 127 /**
129 * Returns destination port of a tunnel. 128 * Returns destination port of a tunnel.
130 * 129 *
131 * @return port number 130 * @return port number
132 */ 131 */
133 - public long dstPort(); 132 + long dstPort();
134 133
135 /** 134 /**
136 * Returns the bandwidth of a tunnel. 135 * Returns the bandwidth of a tunnel.
137 * 136 *
138 * @return bandwidth 137 * @return bandwidth
139 */ 138 */
140 - public long bandWidth(); 139 + long bandWidth();
141 140
142 /** 141 /**
143 * Returns the tunnel id. 142 * Returns the tunnel id.
144 * 143 *
145 * @return id of the PCEP tunnel 144 * @return id of the PCEP tunnel
146 */ 145 */
147 - public long id(); 146 + long id();
148 147
149 /** 148 /**
150 * Returns the detail hop list of a tunnel. 149 * Returns the detail hop list of a tunnel.
151 * 150 *
152 * @return hop list 151 * @return hop list
153 */ 152 */
154 - public List<PcepHopNodeDescription> getHopList(); 153 + List<PcepHopNodeDescription> getHopList();
155 154
156 /** 155 /**
157 * Returns the instance of a pcep tunnel,a instance is used to mark the times of 156 * Returns the instance of a pcep tunnel,a instance is used to mark the times of
...@@ -159,34 +158,34 @@ public interface PcepTunnel extends PcepOperator { ...@@ -159,34 +158,34 @@ public interface PcepTunnel extends PcepOperator {
159 * 158 *
160 * @return the instance of a tunnel. 159 * @return the instance of a tunnel.
161 */ 160 */
162 - public int getInstance(); 161 + int getInstance();
163 162
164 /** 163 /**
165 * Returns the state of a path. 164 * Returns the state of a path.
166 * 165 *
167 * @return normal or broken 166 * @return normal or broken
168 */ 167 */
169 - public PathState getPathState(); 168 + PathState getPathState();
170 169
171 /** 170 /**
172 * Returns the ability of a tunnel. 171 * Returns the ability of a tunnel.
173 * 172 *
174 * @return ability of the tunenl 173 * @return ability of the tunenl
175 */ 174 */
176 - public Ability getSla(); 175 + Ability getSla();
177 176
178 /** 177 /**
179 * Returns the path type of a path if the tunnel's ability is diamond . 178 * Returns the path type of a path if the tunnel's ability is diamond .
180 * 179 *
181 * @return the type of a path, the preferred or alternate. 180 * @return the type of a path, the preferred or alternate.
182 */ 181 */
183 - public PATHTYPE getPathType(); 182 + PATHTYPE getPathType();
184 183
185 /** 184 /**
186 * Get the under lay tunnel id of VLAN tunnel. 185 * Get the under lay tunnel id of VLAN tunnel.
187 * 186 *
188 * @return the tunnel id of a OCH tunnel under lay of a VLAN tunnel. 187 * @return the tunnel id of a OCH tunnel under lay of a VLAN tunnel.
189 */ 188 */
190 - public long underlayTunnelId(); 189 + long underlayTunnelId();
191 190
192 } 191 }
......
...@@ -26,6 +26,6 @@ public interface PcepTunnelListener { ...@@ -26,6 +26,6 @@ public interface PcepTunnelListener {
26 * 26 *
27 * @param tunnel a pceptunnel. 27 * @param tunnel a pceptunnel.
28 */ 28 */
29 - public void handlePCEPTunnel(PcepTunnel tunnel); 29 + void handlePCEPTunnel(PcepTunnel tunnel);
30 30
31 } 31 }
......