1   /* Copyright 2002-2025 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  
19  import org.orekit.files.ccsds.utils.ContextBinding;
20  import org.orekit.files.ccsds.utils.lexical.ParseToken;
21  import org.orekit.files.ccsds.utils.lexical.TokenType;
22  
23  /** Keywords allowed in {@link Header}.
24   * @author Luc Maisonobe
25   * @since 11.0
26   */
27  public enum HeaderKey {
28  
29      /** Header comment. */
30      COMMENT((token, context, header) ->
31              token.getType() == TokenType.ENTRY ? header.addComment(token.getContentAsNormalizedString()) : true),
32  
33      /** Classification.
34       * @since 12.0
35       */
36      CLASSIFICATION((token, context, header) -> token.processAsFreeTextString(header::setClassification)),
37  
38      /** Creation date. */
39      CREATION_DATE((token, context, header) -> token.processAsDate(header::setCreationDate, context)),
40  
41      /** Creating agency or operator. */
42      ORIGINATOR((token, context, header) -> token.processAsFreeTextString(header::setOriginator)),
43  
44      /** ID that uniquely identifies a message from a given originator. */
45      MESSAGE_ID((token, context, header) -> token.processAsFreeTextString(header::setMessageId));
46  
47      /** Processing method. */
48      private final transient TokenProcessor processor;
49  
50      /** Simple constructor.
51       * @param processor processing method
52       */
53      HeaderKey(final TokenProcessor processor) {
54          this.processor = processor;
55      }
56  
57      /** Process an token.
58       * @param token token to process
59       * @param context context binding
60       * @param header header to fill
61       * @return true of token was accepted
62       */
63      public boolean process(final ParseToken token, final ContextBinding context, final Header header) {
64          return processor.process(token, context, header);
65      }
66  
67      /** Interface for processing one token. */
68      interface TokenProcessor {
69          /** Process one token.
70           * @param token token to process
71           * @param context context binding
72           * @param header header to fill
73           * @return true of token was accepted
74           */
75          boolean process(ParseToken token, ContextBinding context, Header header);
76      }
77  
78  }