DataField.java

  1. /* Copyright 2002-2021 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.gnss.metric.parser;

  18. import org.orekit.errors.OrekitInternalError;

  19. /**
  20.  * Interface for data fields used to parsed encoded messages.
  21.  * @author Bryan Cazabonne
  22.  * @since 11.0
  23.  */
  24. public interface DataField {

  25.     /** Get the value of the field as a boolean.
  26.      * @param message message containing the data
  27.      * @return boolean value of the field
  28.      */
  29.     default boolean booleanValue(EncodedMessage message) {
  30.         // this method should be overwritten
  31.         throw new OrekitInternalError(null);
  32.     }

  33.     /** Get the value of the field as an integer.
  34.      * @param message message containing the data
  35.      * @return integer value of the field
  36.      */
  37.     default int intValue(EncodedMessage message) {
  38.         // this method should be overwritten
  39.         throw new OrekitInternalError(null);
  40.     }

  41.     /** Get the value of the field as a double.
  42.      * @param message message containing the data
  43.      * @return double value of the field
  44.      */
  45.     default double doubleValue(EncodedMessage message) {
  46.         // this method should be overwritten
  47.         throw new OrekitInternalError(null);
  48.     }

  49.     /** Get the value of the field as a String.
  50.      * @param message message containing the data
  51.      * @param n number of UTF8 characters
  52.      * @return String value of the field
  53.      */
  54.     default String stringValue(EncodedMessage message, int n) {
  55.         // this method should be overwritten
  56.         throw new OrekitInternalError(null);
  57.     }

  58. }