[prev in list] [next in list] [prev in thread] [next in thread] 

List:       jakarta-commons-dev
Subject:    [jira] [Comment Edited] (IMAGING-161) Move package commons.itu_t4 to formats.tiff package
From:       Michael_Groß_(JIRA) <jira () apache ! org>
Date:       2015-01-31 22:04:34
Message-ID: JIRA.12766706.1420979776000.223924.1422741874489 () Atlassian ! JIRA
[Download RAW message or body]


    [ https://issues.apache.org/jira/browse/IMAGING-161?page=com.atlassian.jira.plugin \
.system.issuetabpanels:comment-tabpanel&focusedCommentId=14300003#comment-14300003 ] 

Michael Groß edited comment on IMAGING-161 at 1/31/15 10:03 PM:
----------------------------------------------------------------

> We should move the code to the tiff package and make it package private to remove \
> it from the public API.

This could break client code. For this reason I wouldn't recommend to do this. It is \
still a good point, but fixing now it could bring someone in trouble. Lets keep it \
for later.

For my needs any API used for production code must be stable. To keep an API stable \
changes which could break client code needs always a new major release (i.e. from \
version 1.x to 2.x). A new major release needs to support the old and the new version \
(i.e. 1.x and 2.x) for a while so that users have time to switch from old to new API. \
We have no version 1.0 yet but there is a 0.97 released. Reading the issues I am sure \
some people may use this version.

I did a little bit research and found that \
org.apache.commons.imaging.common.itu_t4.T4AndT6Compression is used only in the \
packages org.apache.commons.imaging.formats.tiff.datareaders and ~.write and in a \
test class in org.apache.commons.imaging.formats.tiff.

The other classes, BitArrayOutputStream, BitInputStreamFlexible, HuffmanTree, \
HuffmanTreeException, T4_T6_Tables are used in the package \
org.apache.commons.imaging.common.itu_t4 itself only.

Examined code of commit 979b42f from 2015-01-28 in the \
http://github.com/apache/commons-imaging git repository, branch trunk.


was (Author: mgmechanics):
> We should move the code to the tiff package and make it package private to remove \
> it from the public API.

This could break client code. For this reason I wouldn't recommend to do this. It is \
still a good point, but fixing now it could bring someone in trouble. Lets keep it \
for later.

For my needs any API used for production code must be stable. To keep an API stable \
changes which could break client code needs always a new major release (i.e. from \
version 1.x to 2.x). A new major release needs to support the old and the new version \
(i.e. 1.x and 2.x) for a while so that users have time to switch from old to new API. \
We have no version 1.0 yet but there is a 0.97 released. Reading the issues I am sure \
some people may use this version.

I did a little bit research and found that \
org.apache.commons.imaging.common.itu_t4.HuffmanTree, HuffmanTreeException, \
T4AndT6Compression, T4_T6_Tables are used only in the packages \
org.apache.commons.imaging.formats.tiff.datareaders and ~.write and in a test class \
in org.apache.commons.imaging.formats.tiff.

Examined code of commit 979b42f from 2015-01-28 in the \
http://github.com/apache/commons-imaging git repository, branch trunk.

> Move package commons.itu_t4 to formats.tiff package
> ---------------------------------------------------
> 
> Key: IMAGING-161
> URL: https://issues.apache.org/jira/browse/IMAGING-161
> Project: Commons Imaging
> Issue Type: Improvement
> Components: Format: TIFF, imaging.common.*
> Reporter: Benedikt Ritter
> Fix For: Patch Needed, 1.0
> 
> 
> All public methods from the T4AndT6Compression class are only used in the tiff \
> package. We should move the code to the tiff package and make it package private to \
> remove it from the public API.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


[prev in list] [next in list] [prev in thread] [next in thread]