fix javadoc warnings
[transportpce.git] / networkmodel / src / main / java / org / opendaylight / transportpce / networkmodel / util / LinkIdUtil.java
1 /*
2  * Copyright © 2016 AT&T and others. All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.transportpce.networkmodel.util;
10
11 import java.text.MessageFormat;
12 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils.rev170818.InitRoadmNodesInput;
13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.LinkId;
14
15 public final class LinkIdUtil {
16
17     private static final String NETWORK = "-NETWORK";
18     private static final String TRANSMIT = "-TX";
19     private static final String RECEIVE = "-RX";
20     private static final String BIDIRECTIONAL = "-TXRX";
21     private static final MessageFormat LINK_ID_FORMAT = new MessageFormat("{0}-{1}to{2}-{3}");
22
23     private LinkIdUtil() {
24         // utility class
25     }
26
27     /**
28      * Builds the Link id in format {@link LinkIdUtil#LINK_ID_FORMAT}.
29      *
30      * @param srcNode source node id string
31      * @param srcTp source termination point
32      * @param destNode destination node id
33      * @param destTp destination termination point
34      * @return {@link LinkId}
35      */
36     public static LinkId buildLinkId(String srcNode, String srcTp, String destNode, String destTp) {
37         return new LinkId(LINK_ID_FORMAT
38                 .format(new Object[] {srcNode, srcTp, destNode, destTp}, new StringBuffer(), null).toString());
39     }
40
41     /**
42      * Builds the opposite {@link LinkId} from the {@link InitRoadmNodesInput}.
43      *
44      * @param input an init link for ROADM nodes
45      * @return opposite {@link LinkId}
46      */
47     public static LinkId getRdm2RdmOppositeLinkId(InitRoadmNodesInput input) {
48         String srcNode = new StringBuilder(input.getRdmANode()).append("-DEG").append(input.getDegANum()).toString();
49         String srcTp = input.getTerminationPointA();
50         String destNode = new StringBuilder(input.getRdmZNode()).append("-DEG").append(input.getDegZNum()).toString();
51         String destTp = input.getTerminationPointZ();
52
53         Object[] params = buildParams(srcNode, srcTp, destNode, destTp, false);
54
55         return new LinkId(LINK_ID_FORMAT.format(params, new StringBuffer(), null).toString());
56     }
57
58     /**
59      * Builds the opposite {@link LinkId} from string descriptors.
60      *
61      * @param srcNode a source node
62      * @param srcTp a source termination point
63      * @param destNode a destination node
64      * @param destTp a destination termination point
65      * @return LinkId a link identifier
66      */
67     public static LinkId getOppositeLinkId(String srcNode, String srcTp, String destNode, String destTp) {
68         return getOppositeLinkId(srcNode, srcTp, destNode, destTp, true);
69     }
70
71     /**
72      * Builds the opposite {@link LinkId} from string descriptors.
73      *
74      * @param srcNode a source node
75      * @param srcTp a source termination point
76      * @param destNode a destination node
77      * @param destTp a destination termination point
78      * @param checkNode boolean to check node
79      *
80      * @return LinkId a link identifier
81      */
82     public static LinkId getOppositeLinkId(String srcNode, String srcTp, String destNode, String destTp,
83         boolean checkNode) {
84         Object[] params = buildParams(srcNode, srcTp, destNode, destTp, checkNode);
85         return new LinkId(LINK_ID_FORMAT.format(params, new StringBuffer(), null).toString());
86     }
87
88     private static Object[] buildParams(String srcNode, String srcTp, String destNode, String destTp,
89             boolean checkForNetwork) {
90         Object[] params = null;
91         if (checkBidirectional(checkForNetwork, srcTp)) {
92             if (checkBidirectional(checkForNetwork, destTp)) {
93                 params = new Object[] {destNode, destTp, srcNode, srcTp};
94             } else if (destTp.contains(RECEIVE)) {
95                 params = new Object[] {destNode, destTp.replace("RX", "TX"), srcNode, srcTp};
96             } else {
97                 throw new IllegalArgumentException("Dest Termination Point is either RX/TX_RX ! Check TP");
98             }
99         } else if (srcTp.contains(TRANSMIT)) {
100             String replacedSrcTp = srcTp.replace("TX", "RX");
101             if (checkBidirectional(checkForNetwork, destTp)) {
102                 params = new Object[] {destNode, destTp, srcNode, replacedSrcTp};
103             } else if (destTp.contains(RECEIVE)) {
104                 params = new Object[] {destNode, destTp.replace("RX", "TX"), srcNode, replacedSrcTp};
105             } else {
106                 throw new IllegalArgumentException("Dest Termination Point is either RX/TX_RX ! Check TP");
107             }
108         } else {
109             throw new IllegalArgumentException("SRC Termination Point is either TX/TXRX ! Check TP");
110         }
111         return params;
112     }
113
114     private static boolean checkBidirectional(boolean check, String tp) {
115         return tp.contains(BIDIRECTIONAL) || (check && tp.contains(NETWORK));
116     }
117 }