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 package org.apache.maven.message;
20
21 /**
22 * A factory for {@link MessageBuilder}.
23 *
24 * @since 3.10.0
25 */
26 public interface MessageBuilderFactory {
27 /**
28 * Checks if the underlying output does support styling or not.
29 * @return whether color styling is supported or not
30 */
31 boolean isColorEnabled();
32
33 /**
34 * Returns the terminal width or <code>-1</code> if not supported.
35 * @return the terminal width
36 */
37 int getTerminalWidth();
38
39 /**
40 * Creates a new message builder.
41 * @return a new message builder
42 */
43 MessageBuilder builder();
44
45 /**
46 * Creates a new message builder of the specified size.
47 * @param size the initial size of the message builder buffer
48 * @return a new message builder
49 */
50 MessageBuilder builder(int size);
51 }