-
Notifications
You must be signed in to change notification settings - Fork 0
/
ImageFileFormat.java
148 lines (129 loc) · 5.06 KB
/
ImageFileFormat.java
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*-
* #%L
* anchor-core
* %%
* Copyright (C) 2010 - 2020 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
package org.anchoranalysis.core.format;
import java.util.Optional;
import java.util.stream.Stream;
/**
* A type of image format that are read/written to the filesystem, together with the extensions it
* may use.
*
* <p>Note this is not a complete list of the types of images that Anchor can read or write, rather
* just those that are explicitly mentioned in the code-based, for operations relating to their
* extensions.
*
* @author Owen Feehan
*/
public enum ImageFileFormat implements FileFormat {
/** TIFF */
TIFF("tif", "tiff"),
/** PNG */
PNG("png"),
/** JPEG */
JPEG("jpg", "jpeg"),
/** GIF */
GIF("gif"),
/** Windows Bitmap - note that this comes in many variants. */
BMP("bmp"),
/** OME TIFF */
OME_TIFF("ome.tif", "ome.tiff"),
/** OME XML */
OME_XML("ome.xml");
/**
* The default extension associated with a particular format.
*
* <p>This should be unique across all formats enumerated in {@link ImageFileFormat}.
*/
private final String defaultExtension;
/**
* An alternative extension associated with a particular format.
*
* <p>This should not otherwise appear in either {@code defaultExtension} or {@code
* alternativeExtension} for any other enumerated format.
*/
private final Optional<String> alternativeExtension;
/**
* Creates only with a default-extension.
*
* @param defaultExtension the default extension associated with the created format (which
* should be unique across all enumerated formats), without any leading period.
*/
ImageFileFormat(String defaultExtension) {
this(defaultExtension, Optional.empty());
}
/**
* Creates with a default extension and an alternative extension.
*
* @param defaultExtension the default extension associated with the created format (which
* should be unique across all enumerated formats), without any leading period.
* @param alternativeExtension an alternative extension associated with the created format
* (which should not otherwise be used in another format), without any leading period.
*/
ImageFileFormat(String defaultExtension, String alternativeExtension) {
this(defaultExtension, Optional.of(alternativeExtension));
}
private ImageFileFormat(String defaultExtension, Optional<String> alternativeExtension) {
this.defaultExtension = FormatExtensions.normalizeToLowerCase(defaultExtension);
this.alternativeExtension =
alternativeExtension.map(FormatExtensions::normalizeToLowerCase);
}
/**
* All extensions associated with a file-format.
*
* @return a stream of all extensions associated with a particular file format.
*/
public Stream<String> allExtensions() {
if (alternativeExtension.isPresent()) {
return Stream.of(defaultExtension, alternativeExtension.get());
} else {
return Stream.of(defaultExtension);
}
}
@Override
public boolean matches(String filePath) {
if (FormatExtensions.matches(filePath, defaultExtension)) {
return true;
}
return alternativeExtension.isPresent()
&& FormatExtensions.matches(filePath, alternativeExtension.get());
}
@Override
public String descriptiveIdentifier() {
return getDefaultExtension();
}
@Override
public String getDefaultExtension() {
return defaultExtension;
}
@Override
public boolean matchesIdentifier(String identifier) {
String identifierNormalized = FormatExtensions.removeAnyLeadingPeriod(identifier);
if (identifierNormalized.equalsIgnoreCase(defaultExtension)) {
return true;
}
return alternativeExtension.isPresent()
&& identifierNormalized.equalsIgnoreCase(alternativeExtension.get());
}
}