BUG-49 : removed various PMD warnings.

[bgpcep.git] / bgp / parser-impl / src / main / java / org / opendaylight / protocol / bgp / parser / impl / message / update / CommunityUtil.java

diff --git a/bgp/parser-impl/src/main/java/org/opendaylight/protocol/bgp/parser/impl/message/update/CommunityUtil.java b/bgp/parser-impl/src/main/java/org/opendaylight/protocol/bgp/parser/impl/message/update/CommunityUtil.java
new file mode 100644 (file)
index 0000000..c312b7a
--- /dev/null
+++ b/bgp/parser-impl/src/main/java/org/opendaylight/protocol/bgp/parser/impl/message/update/CommunityUtil.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.protocol.bgp.parser.impl.message.update;
+
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130918.path.attributes.CommunitiesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Community;
+
+/**
+ * Object representation of a RFC1997 Community tag. Communities are a way for the advertising entity to attach semantic
+ * meaning/policy to advertised objects.
+ */
+public final class CommunityUtil {
+       /**
+        * NO_EXPORT community. All routes received carrying a communities attribute containing this value MUST NOT be
+        * advertised outside a BGP confederation boundary (a stand-alone autonomous system that is not part of a
+        * confederation should be considered a confederation itself).
+        */
+       public static final Community NO_EXPORT = CommunityUtil.create(0xFFFF, 0xFF01);
+       /**
+        * NO_ADVERTISE community. All routes received carrying a communities attribute containing this value MUST NOT be
+        * advertised to other BGP peers.
+        */
+       public static final Community NO_ADVERTISE = CommunityUtil.create(0xFFFF, 0xFF02);
+       /**
+        * NO_EXPORT_SUBCONFED community. All routes received carrying a communities attribute containing this value MUST
+        * NOT be advertised to external BGP peers (this includes peers in other members autonomous systems inside a BGP
+        * confederation).
+        */
+       public static final Community NO_EXPORT_SUBCONFED = CommunityUtil.create(0xFFFF, 0xFF03);
+
+       private CommunityUtil() {
+
+       }
+
+       /**
+        * Creates a new Community given AS number value and semantics using generated CommunitiesBuilder.
+        * 
+        * @param asn long
+        * @param semantics long
+        * @return new Community
+        */
+       public static Community create(final long asn, final int semantics) {
+               final CommunitiesBuilder builder = new CommunitiesBuilder();
+               builder.setAsNumber(new AsNumber(asn));
+               builder.setSemantics(semantics);
+               return builder.build();
+       }
+
+       /**
+        * Creates a Community from its String representation.
+        * 
+        * @param string String representation of a community
+        * @return new Community
+        */
+       public static Community valueOf(final String string) {
+               final String[] parts = string.split(":", 2);
+               final CommunitiesBuilder builder = new CommunitiesBuilder();
+               builder.setAsNumber(new AsNumber(Long.valueOf(parts[0])));
+               builder.setSemantics(Integer.valueOf(parts[1]));
+               return builder.build();
+       }
+}