PocMethodFacade.java

  1. /* Copyright 2002-2022 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.files.ccsds.definitions;

  18. import java.util.regex.Pattern;

  19. /** Facade in front of several probability of collision methods in CCSDS messages.
  20.  * @author Bryan Cazabonne
  21.  * @since 11.2
  22.  */
  23. public class PocMethodFacade {

  24.     /** Pattern for POC method names. */
  25.     private static final Pattern PATTERN = Pattern.compile("-");

  26.     /** Name of the method. */
  27.     private final String name;

  28.     /** Method type (may be null). */
  29.     private final PocMethodType type;

  30.     /** Simple constructor.
  31.      * @param name name of the method
  32.      * @param type method type (may be null)
  33.      */
  34.     public PocMethodFacade(final String name, final PocMethodType type) {
  35.         this.name = name;
  36.         this.type = type;
  37.     }

  38.     /** Get the name of the method.
  39.      * @return name of the method
  40.      */
  41.     public String getName() {
  42.         return name;
  43.     }

  44.     /** Get the method type.
  45.      * @return method type
  46.      */
  47.     public PocMethodType getType() {
  48.         return type;
  49.     }

  50.     /** Parse a string from CDM.
  51.      * @param s string to parse
  52.      * @return PoC method facade
  53.      */
  54.     public static PocMethodFacade parse(final String s) {
  55.         PocMethodType type;
  56.         try {
  57.             type = PocMethodType.valueOf(PATTERN.matcher(s).replaceAll("_"));
  58.         } catch (IllegalArgumentException iae) {
  59.             type = null;
  60.         }
  61.         return new PocMethodFacade(s, type);
  62.     }

  63. }