HIGUCHI Yuta | 34a3f69 | 2016-01-09 21:08:57 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
HIGUCHI Yuta | 34a3f69 | 2016-01-09 21:08:57 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.net.optical.device.port; |
| 17 | |
| 18 | import java.util.Optional; |
| 19 | |
| 20 | import org.onosproject.net.Port; |
| 21 | |
| 22 | import com.google.common.annotations.Beta; |
| 23 | |
| 24 | /** |
| 25 | * Abstraction of a class capable of translating generic-Port object |
| 26 | * as another domain-specific Port of type {@code P}. |
| 27 | * |
| 28 | * @param <P> Port type to map generic Port to |
| 29 | */ |
| 30 | @Beta |
| 31 | public interface PortMapper<P extends Port> { |
| 32 | |
| 33 | /** |
| 34 | * Returns true if this port is capable of being projected as {@code <P>}. |
Ray Milkey | bb23e0b | 2016-08-02 17:00:21 -0700 | [diff] [blame] | 35 | * |
| 36 | * @param port port |
| 37 | * @return true if this port can be projected as the given type |
HIGUCHI Yuta | 34a3f69 | 2016-01-09 21:08:57 -0800 | [diff] [blame] | 38 | */ |
| 39 | boolean is(Port port); |
| 40 | |
| 41 | /** |
| 42 | * Returns {@code port} mapped to {@code <P>}. |
| 43 | * |
| 44 | * @param port Port to map |
| 45 | * @return {@code port} mapped to {@code <P>} |
| 46 | */ |
| 47 | Optional<P> as(Port port); |
| 48 | } |