Committed by
Gerrit Code Review
Add javadoc for implementaions of criteria
Change-Id: I8ca77bee161f6e3bc064e47c57292ceaef9b500f
Showing
1 changed file
with
31 additions
and
8 deletions
... | @@ -178,9 +178,8 @@ public final class Criteria { | ... | @@ -178,9 +178,8 @@ public final class Criteria { |
178 | return new OpticalSignalTypeCriterion(sigType, Type.OCH_SIGTYPE); | 178 | return new OpticalSignalTypeCriterion(sigType, Type.OCH_SIGTYPE); |
179 | } | 179 | } |
180 | 180 | ||
181 | - | ||
182 | /** | 181 | /** |
183 | - * Implementations of criteria. | 182 | + * Implementation of input port criterion. |
184 | */ | 183 | */ |
185 | public static final class PortCriterion implements Criterion { | 184 | public static final class PortCriterion implements Criterion { |
186 | private final PortNumber port; | 185 | private final PortNumber port; |
... | @@ -226,6 +225,9 @@ public final class Criteria { | ... | @@ -226,6 +225,9 @@ public final class Criteria { |
226 | } | 225 | } |
227 | 226 | ||
228 | 227 | ||
228 | + /** | ||
229 | + * Implementation of MAC address criterion. | ||
230 | + */ | ||
229 | public static final class EthCriterion implements Criterion { | 231 | public static final class EthCriterion implements Criterion { |
230 | private final MacAddress mac; | 232 | private final MacAddress mac; |
231 | private final Type type; | 233 | private final Type type; |
... | @@ -273,6 +275,9 @@ public final class Criteria { | ... | @@ -273,6 +275,9 @@ public final class Criteria { |
273 | 275 | ||
274 | } | 276 | } |
275 | 277 | ||
278 | + /** | ||
279 | + * Implementation of Ethernet type criterion. | ||
280 | + */ | ||
276 | public static final class EthTypeCriterion implements Criterion { | 281 | public static final class EthTypeCriterion implements Criterion { |
277 | 282 | ||
278 | private final Short ethType; | 283 | private final Short ethType; |
... | @@ -318,7 +323,9 @@ public final class Criteria { | ... | @@ -318,7 +323,9 @@ public final class Criteria { |
318 | 323 | ||
319 | } | 324 | } |
320 | 325 | ||
321 | - | 326 | + /** |
327 | + * Implementation of IP address criterion. | ||
328 | + */ | ||
322 | public static final class IPCriterion implements Criterion { | 329 | public static final class IPCriterion implements Criterion { |
323 | 330 | ||
324 | private final IpPrefix ip; | 331 | private final IpPrefix ip; |
... | @@ -366,7 +373,9 @@ public final class Criteria { | ... | @@ -366,7 +373,9 @@ public final class Criteria { |
366 | 373 | ||
367 | } | 374 | } |
368 | 375 | ||
369 | - | 376 | + /** |
377 | + * Implementation of Internet Protocol Number criterion. | ||
378 | + */ | ||
370 | public static final class IPProtocolCriterion implements Criterion { | 379 | public static final class IPProtocolCriterion implements Criterion { |
371 | 380 | ||
372 | private final Byte proto; | 381 | private final Byte proto; |
... | @@ -411,7 +420,9 @@ public final class Criteria { | ... | @@ -411,7 +420,9 @@ public final class Criteria { |
411 | 420 | ||
412 | } | 421 | } |
413 | 422 | ||
414 | - | 423 | + /** |
424 | + * Implementation of VLAN priority criterion. | ||
425 | + */ | ||
415 | public static final class VlanPcpCriterion implements Criterion { | 426 | public static final class VlanPcpCriterion implements Criterion { |
416 | 427 | ||
417 | private final Byte vlanPcp; | 428 | private final Byte vlanPcp; |
... | @@ -457,7 +468,9 @@ public final class Criteria { | ... | @@ -457,7 +468,9 @@ public final class Criteria { |
457 | 468 | ||
458 | } | 469 | } |
459 | 470 | ||
460 | - | 471 | + /** |
472 | + * Implementation of VLAN ID criterion. | ||
473 | + */ | ||
461 | public static final class VlanIdCriterion implements Criterion { | 474 | public static final class VlanIdCriterion implements Criterion { |
462 | 475 | ||
463 | 476 | ||
... | @@ -504,7 +517,9 @@ public final class Criteria { | ... | @@ -504,7 +517,9 @@ public final class Criteria { |
504 | 517 | ||
505 | } | 518 | } |
506 | 519 | ||
507 | - | 520 | + /** |
521 | + * Implementation of TCP port criterion. | ||
522 | + */ | ||
508 | public static final class TcpPortCriterion implements Criterion { | 523 | public static final class TcpPortCriterion implements Criterion { |
509 | 524 | ||
510 | private final Short tcpPort; | 525 | private final Short tcpPort; |
... | @@ -551,6 +566,9 @@ public final class Criteria { | ... | @@ -551,6 +566,9 @@ public final class Criteria { |
551 | } | 566 | } |
552 | } | 567 | } |
553 | 568 | ||
569 | + /** | ||
570 | + * Implementation of MPLS tag criterion. | ||
571 | + */ | ||
554 | public static final class MplsCriterion implements Criterion { | 572 | public static final class MplsCriterion implements Criterion { |
555 | 573 | ||
556 | private final Integer mplsLabel; | 574 | private final Integer mplsLabel; |
... | @@ -596,7 +614,9 @@ public final class Criteria { | ... | @@ -596,7 +614,9 @@ public final class Criteria { |
596 | 614 | ||
597 | } | 615 | } |
598 | 616 | ||
599 | - | 617 | + /** |
618 | + * Implementation of lambda (wavelength) criterion. | ||
619 | + */ | ||
600 | public static final class LambdaCriterion implements Criterion { | 620 | public static final class LambdaCriterion implements Criterion { |
601 | 621 | ||
602 | private final short lambda; | 622 | private final short lambda; |
... | @@ -641,6 +661,9 @@ public final class Criteria { | ... | @@ -641,6 +661,9 @@ public final class Criteria { |
641 | } | 661 | } |
642 | } | 662 | } |
643 | 663 | ||
664 | + /** | ||
665 | + * Implementation of optical signal type criterion. | ||
666 | + */ | ||
644 | public static final class OpticalSignalTypeCriterion implements Criterion { | 667 | public static final class OpticalSignalTypeCriterion implements Criterion { |
645 | 668 | ||
646 | private final Short signalType; | 669 | private final Short signalType; | ... | ... |
-
Please register or login to post a comment