irods / irods_client_http_java

test wrapper for iRODS HTTP API
0 stars 1 forks source link

Move enum files to `org.irods.operations` package #78

Open sam-i-am012 opened 1 month ago

korydraughn commented 1 month ago

What's the motivation for putting the enums in their own package? How many enums are we talking about?

sam-i-am012 commented 1 month ago

I think by the time I'm done with #41 it will be 5. It's currently under util but if that's fine then never mind.

korydraughn commented 1 month ago

What would the package name be? What would the package contain? Please list the class/enum-type names.

sam-i-am012 commented 1 month ago

Permission is used in collections and data objects endpoint MetadataOperation is used in collections, data objects, resources, and users groups endpoint UserType is used in users and groups endpoint ZoneProperty is used in zones endpoint

I was thinking maybe naming it just enums or constants but that may be too vague.

korydraughn commented 1 month ago

What packages do we have in the project today? Please list them.

sam-i-am012 commented 1 month ago

Operations Properties Serialize Util

also I just realized I should rename these to be lowercase.

korydraughn commented 1 month ago

Yes, those should be lowercase. Good catch.

Given the enumerations are only used with operations, all enum source files can live in the org.irods.operations package.

I'm just now realizing that these packages need to be expanded to include at least a third/forth element (e.g. org.irods.http). I'll write up an issue for that.

sam-i-am012 commented 1 month ago

I see that makes sense. Should I move the enums to org.irods.operations in this issue or does that need a new issue? Or should I just rename this issue?

sam-i-am012 commented 1 month ago

properties should also probably be in the org.irods.operations package since it's only used with operations right?

korydraughn commented 1 month ago

Sounds like a good move to me.

What is properties? A package? An enum? A class?

sam-i-am012 commented 1 month ago

Sorry, Properties is the package that contains all the classes for the methods that have more than one optional parameter.

korydraughn commented 1 month ago

Let's hold on this issue for now. We need to think about this a little more.