1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF 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 * https://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
18 package org.apache.commons.net.nntp;
19
20 /**
21 * A placeholder interface for threadable message objects.
22 *
23 * @param <T> The Threadable implementation.
24 */
25 public interface Threadable<T extends Threadable<T>> {
26
27 /**
28 * Tests whether this is a dummy instance.
29 *
30 * @return whether this is a dummy instance.
31 */
32 boolean isDummy();
33
34 /**
35 * Creates a dummy instance.
36 *
37 * @return a dummy instance.
38 */
39 T makeDummy();
40
41 /**
42 * Gets an ID.
43 *
44 * @return an ID.
45 */
46 String messageThreadId();
47
48 /**
49 * Gets reference strings.
50 *
51 * @return reference strings.
52 */
53 String[] messageThreadReferences();
54
55 /**
56 * Sets the child instance.
57 *
58 * @param child the child instance.
59 */
60 void setChild(T child);
61
62 /**
63 * Sets the next instance.
64 *
65 * @param next the next instance.
66 */
67 void setNext(T next);
68
69 /**
70 * Gets the simplified subject.
71 *
72 * @return the simplified subject.
73 */
74 String simplifiedSubject();
75
76 /**
77 * Tests whether this is a reply.
78 *
79 * @return whether this is a reply.
80 */
81 boolean subjectIsReply();
82 }