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.ndm.cdm;
18  
19  import org.orekit.files.ccsds.utils.ContextBinding;
20  import org.orekit.files.ccsds.utils.lexical.ParseToken;
21  
22  /** Keywords allowed in {@link CdmHeader}.
23   * @author Melina Vanel
24   * @since 11.2
25   */
26  public enum CdmHeaderKey {
27  
28      /** Creating spacecraft name for which the CDM is provided. */
29      MESSAGE_FOR((token, context, header) -> token.processAsUppercaseString(header::setMessageFor)),
30  
31      /** User-defined free-text message classification or caveats of this CDM. */
32      CLASSIFICATION((token, context, header) -> token.processAsNormalizedString(header::setClassification));
33  
34      /** Processing method. */
35      private final transient TokenProcessor processor;
36  
37      /** Simple constructor.
38       * @param processor processing method
39       */
40      CdmHeaderKey(final TokenProcessor processor) {
41          this.processor = processor;
42      }
43  
44      /** Process an token.
45       * @param token token to process
46       * @param context context binding
47       * @param header header to fill
48       * @return true of token was accepted
49       */
50      public boolean process(final ParseToken token, final ContextBinding context, final CdmHeader header) {
51          return processor.process(token, context, header);
52      }
53  
54      /** Interface for processing one token. */
55      interface TokenProcessor {
56          /** Process one token.
57           * @param token token to process
58           * @param context context binding
59           * @param header header to fill
60           * @return true of token was accepted
61           */
62          boolean process(ParseToken token, ContextBinding context, CdmHeader header);
63      }
64  
65  }