summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnits/utils/NamedObjectProduct.java
blob: 9c3079c4d102e51bb7d8331a3274d8044a900c98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
 * Copyright (C) 2021 Adrien Hopkins
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package sevenUnits.utils;

import java.util.Map;

/**
 * An ObjectProduct with name(s) and/or a symbol. Can be created with the
 * {@link ObjectProduct#withName} method.
 * 
 * @author Adrien Hopkins
 * @since 2021-12-15
 */
public class NamedObjectProduct<T> extends ObjectProduct<T>
		implements Nameable {
	private final NameSymbol nameSymbol;
	
	NamedObjectProduct(final Map<T, Integer> exponents,
			final NameSymbol nameSymbol) {
		super(exponents);
		this.nameSymbol = nameSymbol;
	}
	
	@Override
	public NameSymbol getNameSymbol() {
		return this.nameSymbol;
	}
	
	@Override
	public String toString() {
		return this.nameSymbol.toString() + ", " + super.toString();
	}
}