HeaderKey.java

  1. /* Copyright 2002-2024 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.section;

  18. import org.orekit.files.ccsds.utils.ContextBinding;
  19. import org.orekit.files.ccsds.utils.lexical.ParseToken;
  20. import org.orekit.files.ccsds.utils.lexical.TokenType;

  21. /** Keywords allowed in {@link Header}.
  22.  * @author Luc Maisonobe
  23.  * @since 11.0
  24.  */
  25. public enum HeaderKey {

  26.     /** Header comment. */
  27.     COMMENT((token, context, header) ->
  28.             token.getType() == TokenType.ENTRY ? header.addComment(token.getContentAsNormalizedString()) : true),

  29.     /** Classification.
  30.      * @since 12.0
  31.      */
  32.     CLASSIFICATION((token, context, header) -> token.processAsFreeTextString(header::setClassification)),

  33.     /** Creation date. */
  34.     CREATION_DATE((token, context, header) -> token.processAsDate(header::setCreationDate, context)),

  35.     /** Creating agency or operator. */
  36.     ORIGINATOR((token, context, header) -> token.processAsFreeTextString(header::setOriginator)),

  37.     /** ID that uniquely identifies a message from a given originator. */
  38.     MESSAGE_ID((token, context, header) -> token.processAsFreeTextString(header::setMessageId));

  39.     /** Processing method. */
  40.     private final transient TokenProcessor processor;

  41.     /** Simple constructor.
  42.      * @param processor processing method
  43.      */
  44.     HeaderKey(final TokenProcessor processor) {
  45.         this.processor = processor;
  46.     }

  47.     /** Process an token.
  48.      * @param token token to process
  49.      * @param context context binding
  50.      * @param header header to fill
  51.      * @return true of token was accepted
  52.      */
  53.     public boolean process(final ParseToken token, final ContextBinding context, final Header header) {
  54.         return processor.process(token, context, header);
  55.     }

  56.     /** Interface for processing one token. */
  57.     interface TokenProcessor {
  58.         /** Process one token.
  59.          * @param token token to process
  60.          * @param context context binding
  61.          * @param header header to fill
  62.          * @return true of token was accepted
  63.          */
  64.         boolean process(ParseToken token, ContextBinding context, Header header);
  65.     }

  66. }