Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -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 | |
| 17 | package org.onosproject.net.region; |
| 18 | |
| 19 | import org.onlab.util.Identifier; |
| 20 | |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 21 | import static com.google.common.base.Preconditions.checkArgument; |
| 22 | |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 23 | /** |
| 24 | * Region identifier backed by a string value. |
| 25 | */ |
| 26 | public final class RegionId extends Identifier<String> { |
| 27 | |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 28 | private static final int REGION_MAX_LENGTH = 1024; |
| 29 | |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 30 | /** |
| 31 | * Constructor for serialization. |
| 32 | */ |
| 33 | private RegionId() { |
| 34 | super(); |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * Constructs the ID corresponding to a given string value. |
| 39 | * |
| 40 | * @param value the underlying value of this ID |
| 41 | */ |
| 42 | private RegionId(String value) { |
| 43 | super(value); |
Jordan Halterman | 0d89ea3 | 2017-06-13 10:42:36 -0700 | [diff] [blame] | 44 | if (value != null) { |
| 45 | checkArgument(value.length() <= REGION_MAX_LENGTH, "value exceeds maximum length " + REGION_MAX_LENGTH); |
| 46 | } |
Thomas Vachuska | 4844808 | 2016-02-19 22:14:54 -0800 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Creates a new region identifier. |
| 51 | * |
| 52 | * @param id backing identifier value |
| 53 | * @return region identifier |
| 54 | */ |
| 55 | public static RegionId regionId(String id) { |
| 56 | return new RegionId(id); |
| 57 | } |
| 58 | |
| 59 | } |