1 | /**************************************************************** |
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one * |
---|
3 | * or more contributor license agreements. See the NOTICE file * |
---|
4 | * distributed with this work for additional information * |
---|
5 | * regarding copyright ownership. The ASF licenses this file * |
---|
6 | * to you under the Apache License, Version 2.0 (the * |
---|
7 | * "License"); you may not use this file except in compliance * |
---|
8 | * with the License. You may obtain a copy of the License at * |
---|
9 | * * |
---|
10 | * http://www.apache.org/licenses/LICENSE-2.0 * |
---|
11 | * * |
---|
12 | * Unless required by applicable law or agreed to in writing, * |
---|
13 | * software distributed under the License is distributed on an * |
---|
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * |
---|
15 | * KIND, either express or implied. See the License for the * |
---|
16 | * specific language governing permissions and limitations * |
---|
17 | * under the License. * |
---|
18 | ****************************************************************/ |
---|
19 | |
---|
20 | package org.apache.james.mime4j.stream; |
---|
21 | |
---|
22 | /** |
---|
23 | * Enumeration of states an entity is expected to go through |
---|
24 | * in the process of the MIME stream parsing. |
---|
25 | */ |
---|
26 | public enum EntityState { |
---|
27 | /** |
---|
28 | * This token indicates, that the MIME stream is currently |
---|
29 | * at the beginning of a message. |
---|
30 | */ |
---|
31 | T_START_MESSAGE, |
---|
32 | /** |
---|
33 | * This token indicates, that the MIME stream is currently |
---|
34 | * at the end of a message. |
---|
35 | */ |
---|
36 | T_END_MESSAGE, |
---|
37 | /** |
---|
38 | * This token indicates, that a raw entity is currently being processed. |
---|
39 | */ |
---|
40 | T_RAW_ENTITY, |
---|
41 | /** |
---|
42 | * This token indicates, that a message parts headers are now |
---|
43 | * being parsed. |
---|
44 | */ |
---|
45 | T_START_HEADER, |
---|
46 | /** |
---|
47 | * This token indicates, that a message parts field has now |
---|
48 | * been parsed. |
---|
49 | */ |
---|
50 | T_FIELD, |
---|
51 | /** |
---|
52 | * This token indicates, that part headers have now been |
---|
53 | * parsed. |
---|
54 | */ |
---|
55 | T_END_HEADER, |
---|
56 | /** |
---|
57 | * This token indicates, that a multipart body is being parsed. |
---|
58 | */ |
---|
59 | T_START_MULTIPART, |
---|
60 | /** |
---|
61 | * This token indicates, that a multipart body has been parsed. |
---|
62 | */ |
---|
63 | T_END_MULTIPART, |
---|
64 | /** |
---|
65 | * This token indicates, that a multiparts preamble is being |
---|
66 | * parsed. |
---|
67 | */ |
---|
68 | T_PREAMBLE, |
---|
69 | /** |
---|
70 | * This token indicates, that a multiparts epilogue is being |
---|
71 | * parsed. |
---|
72 | */ |
---|
73 | T_EPILOGUE, |
---|
74 | /** |
---|
75 | * This token indicates, that the MIME stream is currently |
---|
76 | * at the beginning of a body part. |
---|
77 | */ |
---|
78 | T_START_BODYPART, |
---|
79 | /** |
---|
80 | * This token indicates, that the MIME stream is currently |
---|
81 | * at the end of a body part. |
---|
82 | */ |
---|
83 | T_END_BODYPART, |
---|
84 | /** |
---|
85 | * This token indicates, that an atomic entity is being parsed. |
---|
86 | */ |
---|
87 | T_BODY, |
---|
88 | /** |
---|
89 | * This token indicates, that the MIME stream has been completely |
---|
90 | * and successfully parsed, and no more data is available. |
---|
91 | */ |
---|
92 | T_END_OF_STREAM |
---|
93 | |
---|
94 | } |
---|