Skip to content

Commit 6a6665e

Browse files
author
Doug Black
committed
add comments explaining naming quirks for sip
1 parent ad7aad6 commit 6a6665e

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

src/main/java/com/twilio/sdk/resource/instance/sip/CredentialListInstance.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@
1414
import com.twilio.sdk.resource.instance.sip.Credential;
1515
import com.twilio.sdk.resource.list.sip.CredentialList;
1616

17-
17+
/**
18+
* This class is the instance resource corresponding to /CredentialLists/CLXXX.
19+
*
20+
* NOTE: The 'Instance' suffix in the name was added to avoid a name clash with the list resource
21+
* that corresponds to /Credentials. This unfortunate quirk is caused by this library's convention of
22+
* appending 'List' to instance resources to form their list counterpart.
23+
*/
1824
public class CredentialListInstance extends InstanceResource {
1925

2026
/** The Constant SID_PROPERTY. */
@@ -30,7 +36,7 @@ public CredentialListInstance(TwilioRestClient client) {
3036
}
3137

3238
/**
33-
* Instantiates a new CredentialList.
39+
* Instantiates a new CredentialListInstance.
3440
*
3541
* @param client the client
3642
* @param sid the sid

src/main/java/com/twilio/sdk/resource/list/sip/IpAccessControlListList.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
import com.twilio.sdk.resource.instance.sip.IpAccessControlList;
1212
import org.apache.http.NameValuePair;
1313

14+
/**
15+
* This class is a list of IpAccessControlLists.
16+
* While the name may seem odd at first, it actually is a list of lists,
17+
* so the name is correct.
18+
*/
1419
public class IpAccessControlListList extends ListResource<IpAccessControlList> implements IpAccessControlListFactory {
1520

1621
/**

0 commit comments

Comments
 (0)