maojianwei | 42e2344 | 2016-02-15 10:40:48 +0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
maojianwei | 42e2344 | 2016-02-15 10:40:48 +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.fnl.base; |
| 17 | |
| 18 | /** |
| 19 | * Represents an additional value that a caller may pass to a method. |
| 20 | * Be filled in by the called method. |
| 21 | * |
| 22 | * Used as an extra return value. |
| 23 | * |
| 24 | * @param <M> the class of expected return value |
| 25 | */ |
| 26 | public final class TsReturn<M> { |
| 27 | private M ret; |
| 28 | |
| 29 | /** |
| 30 | * Sets the value of this instance. |
| 31 | * |
| 32 | * @param value the value to set |
| 33 | */ |
| 34 | public void setValue(M value) { |
| 35 | ret = value; |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Returns the value of this instance. |
| 40 | * |
| 41 | * @return the value |
| 42 | */ |
| 43 | public M getValue() { |
| 44 | return ret; |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Returns true if the value has been set. |
| 49 | * Generally, if setValue() has not been invoked, |
| 50 | * the value will not be present (i.e. null). |
| 51 | * |
| 52 | * @return true, if ret is present; |
| 53 | * false, otherwise |
| 54 | */ |
| 55 | public boolean isPresent() { |
| 56 | return ret != null; |
| 57 | } |
| 58 | } |